Skip to content

应用程序结构

前提条件

概述

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

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

关键概念

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

  1. 一个 LangGraph API 配置文件（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 应用程序所需的依赖项、图、环境变量和其他设置。

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

键 描述
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 的额外行数组。

提示

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.txt、pyproject.toml 或 package.json）。
  2. LangGraph 配置文件中的 dependencies 键，用于指定运行 LangGraph 应用程序所需的依赖项。
  3. 任何额外的二进制文件或系统库可以使用 LangGraph 配置文件中的 dockerfile_lines 键来指定。

图

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

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

环境变量

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

对于生产环境部署，您通常需要在部署环境中配置环境变量。

相关内容

如需更多信息，请参阅以下资源：

Comments