如何使用 pyproject.toml 设置 LangGraph 应用程序¶

LangGraph 应用程序必须使用 LangGraph 配置文件进行配置，才能部署到 LangGraph 平台（或进行自托管）。本操作指南讨论了使用 pyproject.toml 定义包依赖项来设置 LangGraph 应用程序以进行部署的基本步骤。

本教程基于此仓库，你可以试用它以了解更多关于如何设置 LangGraph 应用程序进行部署的信息。

使用 requirements.txt 进行设置

如果你倾向于使用 requirements.txt 进行依赖管理，请查阅本操作指南。

使用 Monorepo 进行设置

如果你对部署位于 monorepo 中的图感兴趣，请查看此仓库以获取示例。

最终的仓库结构将如下所示

my-app/
├── my_agent # all project code lies within here
│   ├── utils # utilities for your graph
│   │   ├── __init__.py
│   │   ├── tools.py # tools for your graph
│   │   ├── nodes.py # node functions for you graph
│   │   └── state.py # state definition of your graph
│   ├── __init__.py
│   └── agent.py # code for constructing your graph
├── .env # environment variables
├── langgraph.json  # configuration file for LangGraph
└── pyproject.toml # dependencies for your project

每一步之后都会提供一个示例文件目录，以演示代码的组织方式。

指定依赖项¶

依赖项可以选择在以下文件中指定：pyproject.toml、setup.py 或 requirements.txt。如果未创建这些文件，则可以在稍后的LangGraph 配置文件中指定依赖项。

以下依赖项将包含在镜像中，你也可以在代码中使用它们，只要版本范围兼容即可

langgraph>=0.3.27
langgraph-sdk>=0.1.66
langgraph-checkpoint>=2.0.23
langchain-core>=0.2.38
langsmith>=0.1.63
orjson>=3.9.7,<3.10.17
httpx>=0.25.0
tenacity>=8.0.0
uvicorn>=0.26.0
sse-starlette>=2.1.0,<2.2.0
uvloop>=0.18.0
httptools>=0.5.0
jsonschema-rs>=0.20.0
structlog>=24.1.0
cloudpickle>=3.0.0

pyproject.toml 文件示例

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "my-agent"
version = "0.0.1"
description = "An excellent agent build for LangGraph Platform."
authors = [
    {name = "Polly the parrot", email = "1223+polly@users.noreply.github.com"}
]
license = {text = "MIT"}
readme = "README.md"
requires-python = ">=3.9"
dependencies = [
    "langgraph>=0.2.0",
    "langchain-fireworks>=0.1.3"
]

[tool.hatch.build.targets.wheel]
packages = ["my_agent"]

示例文件目录

my-app/
└── pyproject.toml   # Python packages required for your graph

指定环境变量¶

环境变量可以选择在文件中指定（例如 .env）。请参阅环境变量参考以配置部署的额外变量。

.env 文件示例

MY_ENV_VAR_1=foo
MY_ENV_VAR_2=bar
FIREWORKS_API_KEY=key

示例文件目录

my-app/
├── .env # file with environment variables
└── pyproject.toml

定义图¶

实现你的图！图可以定义在单个文件或多个文件中。请记下每个要包含在 LangGraph 应用程序中的变量名。这些变量名将在稍后创建LangGraph 配置文件时使用。

agent.py 文件示例，展示了如何从你定义的其他模块导入（模块代码此处未显示，请参阅此仓库以查看其实现）

# my_agent/agent.py
from typing import Literal
from typing_extensions import TypedDict

from langgraph.graph import StateGraph, END, START
from my_agent.utils.nodes import call_model, should_continue, tool_node # import nodes
from my_agent.utils.state import AgentState # import state

# Define the config
class GraphConfig(TypedDict):
    model_name: Literal["anthropic", "openai"]

workflow = StateGraph(AgentState, config_schema=GraphConfig)
workflow.add_node("agent", call_model)
workflow.add_node("action", tool_node)
workflow.add_edge(START, "agent")
workflow.add_conditional_edges(
    "agent",
    should_continue,
    {
        "continue": "action",
        "end": END,
    },
)
workflow.add_edge("action", "agent")

graph = workflow.compile()

示例文件目录

my-app/
├── my_agent # all project code lies within here
│   ├── utils # utilities for your graph
│   │   ├── __init__.py
│   │   ├── tools.py # tools for your graph
│   │   ├── nodes.py # node functions for you graph
│   │   └── state.py # state definition of your graph
│   ├── __init__.py
│   └── agent.py # code for constructing your graph
├── .env
└── pyproject.toml

创建 LangGraph 配置文件¶

创建一个名为 langgraph.json 的 LangGraph 配置文件。有关配置文件 JSON 对象中每个键的详细说明，请参阅LangGraph 配置文件参考。

langgraph.json 文件示例

{
  "dependencies": ["."],
  "graphs": {
    "agent": "./my_agent/agent.py:graph"
  },
  "env": ".env"
}

请注意，CompiledGraph 的变量名出现在顶级 graphs 键中每个子键值的末尾（即 :<variable_name>）。

配置文件位置

LangGraph 配置文件必须放置在与包含编译图和相关依赖项的 Python 文件相同或更高级别的目录中。

示例文件目录

my-app/
├── my_agent # all project code lies within here
│   ├── utils # utilities for your graph
│   │   ├── __init__.py
│   │   ├── tools.py # tools for your graph
│   │   ├── nodes.py # node functions for you graph
│   │   └── state.py # state definition of your graph
│   ├── __init__.py
│   └── agent.py # code for constructing your graph
├── .env # environment variables
├── langgraph.json  # configuration file for LangGraph
└── pyproject.toml # dependencies for your project

下一步¶

设置好项目并将其放置在 GitHub 仓库后，就可以部署你的应用程序了。