应用程序结构¶
概述¶
LangGraph 应用程序由一个或多个图、一个配置文件 (langgraph.json)、一个指定依赖项的文件以及一个指定环境变量的可选 .env 文件组成。
本指南展示了应用程序的典型结构,并展示了如何指定使用 LangGraph Platform 部署应用程序所需的信息。
关键概念¶
要使用 LangGraph Platform 进行部署,应提供以下信息:
- 一个 LangGraph 配置文件 (
langgraph.json),用于指定应用程序使用的依赖项、图和环境变量。 - 实现应用程序逻辑的图。
- 一个指定运行应用程序所需依赖项的文件。
- 应用程序运行所需的环境变量。
文件结构¶
以下是应用程序的目录结构示例:
my-app/
├── src # 所有项目代码都在这里
│ ├── utils # 图的可选实用工具
│ │ ├── tools.ts # 图的工具
│ │ ├── nodes.ts # 图的节点函数
│ │ └── state.ts # 图的状态定义
│ └── agent.ts # 构建图的代码
├── package.json # 包依赖项
├── .env # 环境变量
└── langgraph.json # LangGraph 的配置文件
Note
LangGraph 应用程序的目录结构可能因编程语言和使用的包管理器而异。
配置文件¶
langgraph.json 文件是一个 JSON 文件,用于指定部署 LangGraph 应用程序所需的依赖项、图、环境变量和其他设置。
有关 JSON 文件中所有支持的键的详细信息,请参阅 LangGraph 配置文件参考。
Tip
LangGraph CLI 默认使用当前目录中的配置文件 langgraph.json。
示例¶
- 依赖项涉及自定义本地包和
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 包。
LangGraph 应用程序可能依赖于其他 TypeScript/JavaScript 库。
你通常需要指定以下信息才能正确设置依赖项:
- 目录中指定依赖项的文件(例如
requirements.txt、pyproject.toml或package.json)。
-
目录中指定依赖项的文件(例如
package.json)。 -
LangGraph 配置文件中的
dependencies键,用于指定运行 LangGraph 应用程序所需的依赖项。 - 可以使用 LangGraph 配置文件中的
dockerfile_lines键指定任何其他二进制文件或系统库。
图¶
使用 LangGraph 配置文件中的 graphs 键来指定已部署的 LangGraph 应用程序中将可用的图。
你可以在配置文件中指定一个或多个图。每个图由一个名称(应该是唯一的)和以下任一项的路径标识:(1) 已编译的图或 (2) 定义了创建图的函数。
环境变量¶
如果你在本地使用已部署的 LangGraph 应用程序,你可以在 LangGraph 配置文件的 env 键中配置环境变量。
对于生产部署,你通常希望在部署环境中配置环境变量。