site_name: LangGraph
site_description: Build language agents as graphs
site_url: https://langchain-ai.github.io/langgraph/
repo_url: https://github.com/langchain-ai/langgraph
theme:
  name: material
  custom_dir: overrides
  logo: static/wordmark.png
  favicon: static/favicon.png
  icon:
    repo: fontawesome/brands/git-alt
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.prune
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
  - scheme: default
    primary: white
    accent: gray
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - scheme: slate
    primary: grey
    accent: white
    toggle:
      icon: material/brightness-4
      name: Switch to light mode
  font:
    text: "Public Sans"
    code: "Roboto Mono"
plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://api.python.langchain.com/en/latest/objects.inv
          options:
            members_order: source 
            allow_inspection: true
            heading_level: 3
            show_bases: true
            summary: true
            inherited_members: true
            # merge_init_into_class: true
            selection:
                docstring_style: google
            docstring_section_style: list
            show_root_toc_entry: false 
            # show_signature_annotations: true
            # show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
  - mkdocs-jupyter:
      ignore_h1_titles: true
      execute: false
      include_source: True
      include_requirejs: true
  - git-committers:
      repository: langchain-ai/langgraph
      branch: main
      docs_path: docs/docs/
      token: !ENV ["MKDOCS_GIT_COMMITTERS_APIKEY"]
  # TODO: Add minify plugin once it works alright with code block copying
  # - minify:
  #     minify_html: true
nav:
  - Home: 
      - 'index.md'
      - Quick Start: how-tos/docs/quickstart.ipynb
      - Intro to LangGraph: tutorials/introduction.ipynb
  - Tutorials:
      - 'tutorials/index.md'
      - Introduction: tutorials/introduction.ipynb
      - Chatbots:
          - Customer Support: tutorials/customer-support/customer-support.ipynb
          - Prompt Generation from User Requirements: tutorials/chatbots/information-gather-prompting.ipynb
          - Code Assistant: tutorials/code_assistant/langgraph_code_assistant.ipynb
      - RAG:
          - Adaptive RAG: tutorials/rag/langgraph_adaptive_rag.ipynb
          - Adaptive RAG using local LLMs: tutorials/rag/langgraph_adaptive_rag_local.ipynb
          - Agentic RAG: tutorials/rag/langgraph_agentic_rag.ipynb
          - Corrective RAG (CRAG): tutorials/rag/langgraph_crag.ipynb
          - Corrective RAG (CRAG) using local LLMs: tutorials/rag/langgraph_crag_local.ipynb
          - Self-RAG: tutorials/rag/langgraph_self_rag.ipynb
          - Self-RAG using local LLMs: tutorials/rag/langgraph_self_rag_local.ipynb
          - SQL Agent: tutorials/sql-agent.ipynb
      - Agent Architectures:
        - Multi-Agent Systems:
            - Collaboration: tutorials/multi_agent/multi-agent-collaboration.ipynb
            - Supervision: tutorials/multi_agent/agent_supervisor.ipynb
            - Hierarchical Teams: tutorials/multi_agent/hierarchical_agent_teams.ipynb
        - Planning Agents:
            - Plan-and-Execute: tutorials/plan-and-execute/plan-and-execute.ipynb
            - Reasoning without Observation: tutorials/rewoo/rewoo.ipynb
            - LLMCompiler: tutorials/llm-compiler/LLMCompiler.ipynb
        - Reflection & Critique:
            - Basic Reflection: tutorials/reflection/reflection.ipynb
            - Reflexion: tutorials/reflexion/reflexion.ipynb
            - Language Agent Tree Search: tutorials/lats/lats.ipynb
            - Self-Discover Agent: tutorials/self-discover/self-discover.ipynb
      - Evaluation & Analysis:
          - Chatbot Evaluation via Simulation:
              - Agent-based: tutorials/chatbot-simulation-evaluation/agent-simulation-evaluation.ipynb
              - In LangSmith: tutorials/chatbot-simulation-evaluation/langsmith-agent-simulation-evaluation.ipynb
      - Experimental:
        - Web Research (STORM): tutorials/storm/storm.ipynb
        - TNT-LLM: tutorials/tnt-llm/tnt-llm.ipynb
        - Web Navigation: tutorials/web-navigation/web_voyager.ipynb
        - Competitive Programming: tutorials/usaco/usaco.ipynb

  - "How-to Guides":
     - 'how-tos/index.md'
     - Core:
         - Create a ReAct agent: how-tos/create-react-agent.ipynb
         - Add persistence ("memory"): how-tos/persistence.ipynb
         - View and update graph state: how-tos/time-travel.ipynb
         - Run graph asynchronously: how-tos/async.ipynb
         - Stream graph responses: how-tos/streaming-tokens.ipynb
         - Visualize your graph: how-tos/visualization.ipynb
         - Add runtime configuration: how-tos/configuration.ipynb
     - Design Patterns:
         - Create subgraphs: how-tos/subgraph.ipynb
         - Create branches for parallel execution: how-tos/branching.ipynb
         - Create map-reduce branches for parallel execution: how-tos/map-reduce.ipynb
         - Add human-in-the-loop: how-tos/human-in-the-loop.ipynb
         - Force an agent to call a tool: how-tos/force-calling-a-tool-first.ipynb
         - Pass runtime values to tools: how-tos/pass-run-time-values-to-tools.ipynb
         - Let agent return tool results directly: how-tos/dynamically-returning-directly.ipynb
         - Have agent respond in structured format: how-tos/respond-in-format.ipynb
         - Manage agent steps: how-tos/managing-agent-steps.ipynb
     - Advanced:
         - Use Pydantic model as state: how-tos/state-model.ipynb
         - Extract structured output with re-prompting: how-tos/extraction/retries.ipynb
  - 'Conceptual Guides':
     - 'concepts/index.md'
  - Reference:
      - Graphs: reference/graphs.md
      - Checkpointing: reference/checkpoints.md
      - Prebuilt Components: reference/prebuilt.md
      - Errors: reference/errors.md
  - 'Cloud (alpha)':
      - 'cloud/index.md'
      - Tutorials:
          - Quick Start: 'cloud/quick_start.md'
          - SDK:
              - Python: 'cloud/sdk/python_sdk.ipynb'
              - JS/TS: 'cloud/sdk/js_sdk.ipynb'
          - Deployment:
              - Self-Hosted: 'cloud/deployment/self_hosted.md'
              - Managed: 'cloud/deployment/managed.md'
      - How-to Guides:
          - Streaming:
              - Stream Messages: 'cloud/how-tos/cloud_examples/stream_messages.ipynb'
              - Stream Values: 'cloud/how-tos/cloud_examples/stream_values.ipynb'
              - Stream Updates: 'cloud/how-tos/cloud_examples/stream_updates.ipynb'
          - Double Texting: 
              - Interrupt: 'cloud/how-tos/cloud_examples/interrupt_concurrent.ipynb'
              - Rollback: 'cloud/how-tos/cloud_examples/rollback_concurrent.ipynb'
              - Reject: 'cloud/how-tos/cloud_examples/reject_concurrent.ipynb'
              - Enqueue: 'cloud/how-tos/cloud_examples/enqueue_concurrent.ipynb'
          - Run Agent in Background: 'cloud/how-tos/cloud_examples/background_run.ipynb'
          - Run Multiple Agents in Thread: 'cloud/how-tos/cloud_examples/same-thread.ipynb'
          - Human in the loop: 'cloud/how-tos/cloud_examples/human-in-the-loop_cloud.ipynb'
          - Create Agents with Configuration: 'cloud/how-tos/cloud_examples/configuration_cloud.ipynb'
      - Conceptual Guides:
          - API Concepts: 'cloud/api_concepts.md'
      - Reference:
          - API: 'cloud/reference/api_ref.md'
          - SDK:
              - Python: 'cloud/reference/sdk/python_sdk_ref.md'
              - JS/TS: 'cloud/reference/sdk/js_ts_sdk_ref.md'
          - CLI: 'cloud/reference/cli.md'


markdown_extensions:
  - abbr
  - admonition
  - pymdownx.details
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: langchain-ai 
      repo: langgraph
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tasklist:
      custom_checkbox: true
extra_css:
  - css/mkdocstrings.css

extra:
  social:
    - icon: fontawesome/brands/js 
      link: https://langchain-ai.github.io/langgraphjs/
    - icon: fontawesome/brands/github
      link: https://github.com/langchain-ai/langgraph
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/LangChainAI
  analytics:
    - provider: google
    - property: G-G8X6ELZYE0
    - feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback! Please help us improve this page by adding to the discussion below.