Skip to content

应用结构

概述

一个LangGraph应用程序由一个或多个图(graph)组成,还包括一个LangGraph API配置文件(langgraph.json)、一个指定依赖关系的文件以及一个可选的环境变量文件(.env)。

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

关键概念

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

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

在翻译过程中,保持了原文的专业术语和格式,并正确处理了anchor锚点的翻译。

文件结构

以下是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) pyproject.tomlsetup.pyrequirements.txt 文件在应用目录 "./local_package" 中,或 (3) 包名。
graphs 必需。从图 ID 到定义编译后的图或生成图函数的路径的映射。示例:
  • ./your_package/your_file.py:variable,其中 variablelanggraph.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.113.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.txtpyproject.tomlpackage.json)。
  2. LangGraph配置文件中使用 dependencies 键来指定运行LangGraph应用程序所需的依赖项。
  3. 可以使用LangGraph配置文件中的 dockerfile_lines 键来指定任何额外的二进制文件或系统库。

图表

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

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

环境变量

如果您在本地工作时使用了部署好的LangGraph应用程序,您可以在LangGraph配置文件env键中配置环境变量。

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

相关资源

如需更多信息,请参阅以下资源:

Comments