应用程序必须使用配置文件进行配置才能部署到 LangSmith(或进行自托管)。本操作指南讨论使用 pyproject.toml 定义包的依赖项来设置应用程序以进行部署的基本步骤。
本示例基于此存储库,该存储库使用 LangGraph 框架。
最终的存储库结构将如下所示:
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 your 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
LangSmith Deployment 支持部署 LangGraph 图。但是,图的_节点_的实现可以包含任意 Python 代码。这意味着任何框架都可以在节点内实现并部署在 LangSmith Deployment 上。这使您可以将核心应用程序逻辑保留在 LangGraph 之外,同时仍然使用 LangSmith 进行部署、扩展和可观测性。
您还可以使用以下方式设置:
requirements.txt:用于依赖项管理,请查看此操作指南了解如何为 LangSmith 使用 requirements.txt。
- 单体存储库(monorepo):要部署位于单体存储库内的图,请查看此存储库以获取如何执行此操作的示例。
每个步骤后,都会提供一个示例文件目录来演示如何组织代码。
指定依赖项
依赖项可以选择在以下文件之一中指定:pyproject.toml、setup.py 或 requirements.txt。如果这些文件都没有创建,则可以稍后在配置文件中指定依赖项。
下面的依赖项将包含在镜像中,您也可以在代码中使用它们,只要版本范围兼容:
langgraph>=0.6.0
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
Example pyproject.toml file:
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[project]
name = "my-agent"
version = "0.0.1"
description = "An excellent agent build for LangSmith."
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.6.0",
"langchain-fireworks>=0.1.3"
]
[tool.hatch.build.targets.wheel]
packages = ["my_agent"]
Example file directory:
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
默认情况下,LangSmith 遵循 uv/pip 的行为,不安装预发布版本,除非明确允许。如果您想使用预发布版本,您有以下选项:
- 使用
pyproject.toml:在您的 [tool.uv] 部分添加 allow-prereleases = true。
- 使用
requirements.txt 或 setup.py:您必须明确指定每个预发布依赖项,包括传递依赖项。例如,如果您声明 a==0.0.1a1 且 a 依赖于 b==0.0.1a1,那么您还必须在依赖项中明确包含 b==0.0.1a1。
定义图
实现您的图。图可以定义在单个文件或多个文件中。请注意每个 CompiledStateGraph 的变量名称,以便在创建 配置文件 时包含在应用程序中。变量名称将在稍后用于创建 配置文件。
示例 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 runtime context
class GraphContext(TypedDict):
model_name: Literal["anthropic", "openai"]
workflow = StateGraph(AgentState, context_schema=GraphContext)
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 your graph
│ │ └── state.py # state definition of your graph
│ ├── __init__.py
│ └── agent.py # code for constructing your graph
├── .env
└── pyproject.toml
创建配置文件
创建一个名为 langgraph.json 的配置文件。有关配置文件 JSON 对象中每个键的详细说明,请参阅配置文件参考。
示例 langgraph.json 文件:
{
"dependencies": ["."],
"graphs": {
"agent": "./my_agent/agent.py:graph"
},
"env": ".env"
}
请注意,CompiledGraph 的变量名会出现在顶层 graphs 键中每个子键值的末尾(即 :<variable_name>)。
配置文件位置
配置文件必须放在与包含编译图及其依赖项的 Python 文件相同或更高层级的目录中。
示例文件目录结构:
my-app/
├── my_agent # 所有项目代码都位于此处
│ ├── utils # 图的工具函数
│ │ ├── __init__.py
│ │ ├── tools.py # 图使用的工具
│ │ ├── nodes.py # 图的节点函数
│ │ └── state.py # 图的状态定义
│ ├── __init__.py
│ └── agent.py # 构建图的代码
├── .env # 环境变量
├── langgraph.json # LangGraph 的配置文件
└── pyproject.toml # 项目的依赖配置
接下来
在您设置项目并将其放置在 GitHub 仓库后,是时候 部署您的应用 了。