Skip to content

应用结构

概述

一个 LangGraph 应用程序由一个或多个图、一个配置文件(langgraph.json)、一个指定依赖项的文件以及一个可选的用于指定环境变量的 .env 文件组成。

本指南展示了一个典型应用程序的结构,并说明如何使用 LangGraph 平台部署应用程序所需的配置信息。

关键概念

要使用 LangGraph 平台进行部署,应提供以下信息:

  1. 一个 LangGraph 配置文件 (langgraph.json),用于指定应用程序所使用的依赖项、图表和环境变量。
  2. 实现应用程序逻辑的 图表
  3. 指定运行应用程序所需 依赖项 的文件。
  4. 应用程序运行所需的 环境变量

文件结构

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

my-app/
├── my_agent # 所有项目代码位于此处
│   ├── utils # 用于你的图的实用工具
│   │   ├── __init__.py
│   │   ├── tools.py # 用于你的图的工具
│   │   ├── nodes.py # 用于你的图的节点函数
│   │   └── state.py # 你图的状态定义
│   ├── __init__.py
│   └── agent.py # 构建你图的代码
├── .env # 环境变量
├── requirements.txt # 包依赖
└── 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 应用程序所需的依赖项、图、环境变量和其他设置。

有关 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 包或 JavaScript 库(取决于应用所使用的编程语言)。

通常,你需要指定以下信息以正确设置依赖项:

  1. 一个指定依赖项的文件(例如 requirements.txtpyproject.tomlpackage.json)。
  2. LangGraph 配置文件 中的 dependencies 键,用于指定运行 LangGraph 应用所需的依赖项。
  3. 任何额外的二进制文件或系统库可以通过 LangGraph 配置文件 中的 dockerfile_lines 键进行指定。

图表

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

你可以在配置文件中指定一个或多个图表。每个图表通过名称(应唯一)和路径来标识,路径可以是:(1) 编译后的图表,或者 (2) 定义图表的函数。

环境变量

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

对于生产环境部署,你通常希望在部署环境中配置环境变量。