LangGraph CLI¶

LangGraph 命令行界面包含用于在 Docker 中本地构建和运行 LangGraph 云 API 服务器的命令。对于开发和测试，您可以使用 CLI 部署一个本地 API 服务器，作为 Studio 桌面应用 的替代方案。

安装¶

1. 确保已安装 Docker（例如，docker --version）。

2. 安装 langgraph-cli 包：

   pipHomebrew（仅限 MacOS）

   pip install langgraph-cli
   

   brew install langgraph-cli
   

3. 运行命令 langgraph --help 确认 CLI 已安装。

配置文件¶

LangGraph CLI 需要一个 JSON 配置文件，包含以下键：

示例¶

基本配置¶

{
  "dependencies": ["."],
  "graphs": {
    "chat": "./chat/graph.py:graph"
  }
}

向存储添加语义搜索¶

所有部署都带有数据库支持的 BaseStore。在 langgraph.json 中添加“index”配置将启用您部署的 BaseStore 中的 语义搜索。

fields 配置决定了要嵌入的文档部分： - 如果省略或设置为 ["$"]，将嵌入整个文档 - 要嵌入特定字段，使用 JSON 路径表示法：["metadata.title", "content.text"] - 缺少指定字段的文档仍将存储，但不会有这些字段的嵌入 - 您仍然可以在 put 时使用 index 参数覆盖要嵌入的特定字段

{
  "dependencies": ["."],
  "graphs": {
    "memory_agent": "./agent/graph.py:graph"
  },
  "store": {
    "index": {
      "embed": "openai:text-embedding-3-small",
      "dims": 1536,
      "fields": ["$"]
    }
  }
}

- openai:text-embedding-3-large: 3072
- openai:text-embedding-3-small: 1536
- openai:text-embedding-ada-002: 1536
- cohere:embed-english-v3.0: 1024
- cohere:embed-english-light-v3.0: 384
- cohere:embed-multilingual-v3.0: 1024
- cohere:embed-multilingual-light-v3.0: 384

使用自定义嵌入函数的语义搜索¶

如果您希望使用自定义嵌入函数进行语义搜索，可以传递自定义嵌入函数的路径：

{
  "dependencies": ["."],
  "graphs": {
    "memory_agent": "./agent/graph.py:graph"
  },
  "store": {
    "index": {
      "embed": "./embeddings.py:embed_texts",
      "dims": 768,
      "fields": ["text", "summary"]
    }
  }
}

存储配置中的 embed 字段可以引用一个自定义函数，该函数接受一个字符串列表并返回一个嵌入列表。示例实现：

# embeddings.py
def embed_texts(texts: list[str]) -> list[list[float]]:
    """用于语义搜索的自定义嵌入函数。"""
    # 使用您首选的嵌入模型实现
    return [[0.1, 0.2, ...] for _ in texts]  # 维度向量

命令¶

LangGraph CLI 的基本命令是 langgraph。

用法

langgraph [OPTIONS] COMMAND [ARGS]

dev¶

以开发模式运行 LangGraph API 服务器，具有热重载和调试功能。这个轻量级服务器不需要 Docker 安装，适合开发和测试。状态保存在本地目录中。

安装

该命令需要安装“inmem”附加功能：

pip install -U "langgraph-cli[inmem]"

用法

langgraph dev [OPTIONS]

选项

build¶

构建 LangGraph Cloud API 服务器 Docker 镜像。

用法

langgraph build [OPTIONS]

选项

up¶

启动 LangGraph API 服务器。用于本地测试，需要一个具有 LangGraph Cloud 闭门测试访问权限的 LangSmith API 密钥。生产使用需许可证密钥。

用法

langgraph up [OPTIONS]

选项

dockerfile¶

生成用于构建 LangGraph Cloud API 服务器 Docker 镜像的 Dockerfile。

用法

langgraph dockerfile [OPTIONS] SAVE_PATH

选项

示例：

langgraph dockerfile -c langgraph.json Dockerfile

这将生成一个类似于以下内容的 Dockerfile：

FROM langchain/langgraph-api:3.11

ADD ./pipconf.txt /pipconfig.txt

RUN PIP_CONFIG_FILE=/pipconfig.txt PYTHONDONTWRITEBYTECODE=1 pip install --no-cache-dir -c /api/constraints.txt langchain_community langchain_anthropic langchain_openai wikipedia scikit-learn

ADD ./graphs /deps/__outer_graphs/src
RUN set -ex && \
    for line in '[project]' \
                'name = "graphs"' \
                'version = "0.1"' \
                '[tool.setuptools.package-data]' \
                '"*" = ["**/*"]'; do \
        echo "$line" >> /deps/__outer_graphs/pyproject.toml; \
    done

RUN PIP_CONFIG_FILE=/pipconfig.txt PYTHONDONTWRITEBYTECODE=1 pip install --no-cache-dir -c /api/constraints.txt -e /deps/*

ENV LANGSERVE_GRAPHS='{"agent": "/deps/__outer_graphs/src/agent.py:graph", "storm": "/deps/__outer_graphs/src/storm.py:graph"}'