应用程序结构¶

先决条件

概述¶

一个 LangGraph 应用程序由一个或多个图、一个 LangGraph API 配置文件（langgraph.json）、一个指定依赖关系的文件，以及一个可选的 .env 文件（该文件指定环境变量）组成。

本指南展示了 LangGraph 应用程序的典型结构，并说明了在 LangGraph 平台上部署 LangGraph 应用程序所需的信息是如何指定的。

关键概念¶

要使用 LangGraph 平台进行部署，需提供以下信息：

一个 LangGraph API 配置文件（langgraph.json），该文件指定了应用程序所需的依赖关系、图、环境变量。
实现应用程序逻辑的图。
一个指定运行应用程序所需的依赖关系的文件。
应用程序运行所需的环境变量。

文件结构¶

以下是 Python 和 JavaScript 应用程序目录结构的示例：

Python (requirements.txt)Python (pyproject.toml)JS (package.json)

my-app/
├── my_agent # 所有项目代码均在此
│   ├── utils # 图的实用工具
│   │   ├── __init__.py
│   │   ├── tools.py # 图的工具
│   │   ├── nodes.py # 图的节点函数
│   │   └── state.py # 图的状态定义
│   ├── requirements.txt # 包依赖
│   ├── __init__.py
│   └── agent.py # 构建图的代码
├── .env # 环境变量
└── langgraph.json # LangGraph 配置文件

my-app/
├── my_agent # 所有项目代码均在此
│   ├── utils # 图的实用工具
│   │   ├── __init__.py
│   │   ├── tools.py # 图的工具
│   │   ├── nodes.py # 图的节点函数
│   │   └── state.py # 图的状态定义
│   ├── __init__.py
│   └── agent.py # 构建图的代码
├── .env # 环境变量
├── langgraph.json  # LangGraph 配置文件
└── pyproject.toml # 项目的依赖

my-app/
├── src # 所有项目代码均在此
│   ├── utils # 图的可选实用工具
│   │   ├── tools.ts # 图的工具
│   │   ├── nodes.ts # 图的节点函数
│   │   └── state.ts # 图的状态定义
│   └── agent.ts # 构建图的代码
├── package.json # 包依赖
├── .env # 环境变量
└── langgraph.json # LangGraph 配置文件

Note

LangGraph 应用程序的目录结构可能因编程语言和使用的包管理器而异。

配置文件¶

langgraph.json 文件是一个 JSON 文件，指定了部署 LangGraph 应用程序所需的依赖关系、图、环境变量及其他设置。

该文件支持以下信息的指定：

键	描述
`dependencies`	必需。LangGraph API 服务器的依赖关系数组。依赖关系可以是以下之一：(1) `"."`，将查找本地 Python 包，(2) 应用程序目录 `"./local_package"` 中的 `pyproject.toml`、`setup.py` 或 `requirements.txt`，或 (3) 一个包名称。
`graphs`	必需。图 ID 到编译图或定义图的函数路径的映射。例如： `./your_package/your_file.py:variable`，其中 `variable` 是 `langgraph.graph.state.CompiledStateGraph` 的实例 `./your_package/your_file.py:make_graph`，其中 `make_graph` 是一个接受配置字典（`langchain_core.runnables.RunnableConfig`）并创建 `langgraph.graph.state.StateGraph` / `langgraph.graph.state.CompiledStateGraph` 实例的函数。
`env`	`.env` 文件的路径或环境变量与其值的映射。
`python_version`	`3.11` 或 `3.12`。默认值为 `3.11`。
`pip_config_file`	`pip` 配置文件的路径。
`dockerfile_lines`	添加到 Dockerfile 的附加行数组，位于从父映像的导入之后。

Tip

LangGraph CLI 默认使用当前目录中的配置文件 langgraph.json。

示例¶

PythonJavaScript

依赖关系包括一个自定义本地包和 langchain_openai 包。
从文件 ./your_package/your_file.py 中加载一个图，变量为 variable。
环境变量从 .env 文件加载。

{
    "dependencies": [
        "langchain_openai",
        "./your_package"
    ],
    "graphs": {
        "my_agent": "./your_package/your_file.py:agent"
    },
    "env": "./.env"
}

依赖关系将从本地目录中的依赖文件中加载（例如，package.json）。
从文件 ./your_package/your_file.js 中加载一个图，函数为 agent。
环境变量 OPENAI_API_KEY 内联设置。

{
    "dependencies": [
        "."
    ],
    "graphs": {
        "my_agent": "./your_package/your_file.js:agent"
    },
    "env": {
        "OPENAI_API_KEY": "secret-key"
    }
}

依赖关系¶

一个 LangGraph 应用程序可能依赖于其他 Python 包或 JavaScript 库（根据应用程序编写的编程语言）。

通常，您需要指定以下信息以正确设置依赖关系：

目录中指定依赖关系的文件（例如，requirements.txt、pyproject.toml 或 package.json）。
LangGraph 配置文件中的 dependencies 键，指定运行 LangGraph 应用程序所需的依赖关系。
任何额外的二进制文件或系统库可以通过 LangGraph 配置文件中的 dockerfile_lines 键指定。

图¶

使用 LangGraph 配置文件中的 graphs 键来指定在部署的 LangGraph 应用程序中可用的图。

您可以在配置文件中指定一个或多个图。每个图由一个名称（应是唯一的）和一个路径标识，可以是：(1) 编译图的路径或 (2) 定义图的函数的路径。

环境变量¶

如果您在本地使用已部署的 LangGraph 应用程序，可以在 LangGraph 配置文件的 env 键中配置环境变量。

对于生产环境的部署，您通常希望在部署环境中配置环境变量。