LangGraph CLI¶

基本配置¶

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

使用 Wolfi 基础镜像¶

您可以使用 image_distro 字段指定基础镜像的 Linux 发行版。有效选项为 debian 或 wolfi。Wolfi 是推荐选项，因为它提供了更小且更安全的镜像。此功能在 langgraph-cli>=0.2.11 中可用。

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

向 store 添加语义搜索¶

所有部署都带有基于数据库的 BaseStore。在您的 langgraph.json 中添加一个 "index" 配置将启用您部署的 BaseStore 内的 语义搜索。

index.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": ["$"]
    }
  }
}

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

如果您想使用自定义嵌入函数进行语义搜索，您可以传递一个指向自定义嵌入函数的路径：

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

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

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

添加自定义认证¶

{
  "dependencies": ["."],
  "graphs": {
    "chat": "./chat/graph.py:graph"
  },
  "auth": {
    "path": "./auth.py:auth",
    "openapi": {
      "securitySchemes": {
        "apiKeyAuth": {
          "type": "apiKey",
          "in": "header",
          "name": "X-API-Key"
        }
      },
      "security": [{ "apiKeyAuth": [] }]
    },
    "disable_studio_auth": false
  }
}

有关详细信息，请参阅认证概念指南，以及设置自定义认证指南，了解该过程的实际操作步骤。

配置 Store 项目生存时间（TTL）¶

您可以使用 store.ttl 键来配置 BaseStore 中项目/记忆的默认数据过期时间。这决定了项目在最后一次访问后保留多久（读取可能根据 refresh_on_read 重置计时器）。请注意，这些默认值可以通过修改 get、search 等中的相应参数，在每次调用的基础上覆盖。

ttl 配置是一个包含可选字段的对象：

• refresh_on_read：如果为 true（默认），通过 get 或 search 访问项目将重置其过期计时器。设置为 false 仅在写入（put）时刷新 TTL。
• default_ttl：项目的默认寿命，以 分钟 为单位。如果不设置，项目默认不会过期。
• sweep_interval_minutes：系统应运行后台进程删除过期项目的频率（以分钟为单位）。如果不设置，不会自动进行清理。

下面是一个启用 7 天 TTL（10080 分钟）、在读取时刷新，并每小时清理一次的示例：

{
  "dependencies": ["."],
  "graphs": {
    "memory_agent": "./agent/graph.py:graph"
  },
  "store": {
    "ttl": {
      "refresh_on_read": true,
      "sweep_interval_minutes": 60,
      "default_ttl": 10080 
    }
  }
}

配置检查点生存时间（TTL）¶

您可以使用 checkpointer 键来配置检查点的生存时间（TTL）。这决定了检查点数据在按指定策略（例如删除）自动处理前保留多长时间。ttl 配置是一个包含以下字段的对象：

• strategy：对过期检查点采取的操作（目前只接受 "delete"）。
• sweep_interval_minutes：系统检查过期检查点的频率（以分钟为单位）。
• default_ttl：检查点的默认寿命，以 分钟 为单位。

下面是一个设置默认 TTL 为 30 天（43200 分钟）的示例：

{
  "dependencies": ["."],
  "graphs": {
    "chat": "./chat/graph.py:graph"
  },
  "checkpointer": {
    "ttl": {
      "strategy": "delete",
      "sweep_interval_minutes": 10,
      "default_ttl": 43200
    }
  }
}

在这个示例中，超过 30 天的检查点将被删除，并且每 10 分钟检查一次。

基本配置¶

{
  "graphs": {
    "chat": "./src/graph.ts:graph"
  }
}

LangGraph CLI 的基础命令是 langgraph。

langgraph [OPTIONS] COMMAND [ARGS]

LangGraph.js CLI 的基础命令是 langgraphjs。

npx @langchain/langgraph-cli [OPTIONS] COMMAND [ARGS]

我们建议使用 npx 以始终使用 CLI 的最新版本。

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

安装

此命令需要安装 "inmem" 额外依赖项：

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

用法

langgraph dev [OPTIONS]

选项

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

用法

npx @langchain/langgraph-cli dev [OPTIONS]

选项

构建 LangGraph 平台 API 服务器的 Docker 镜像。

用法

langgraph build [OPTIONS]

选项

构建 LangGraph 平台 API 服务器的 Docker 镜像。

用法

npx @langchain/langgraph-cli build [OPTIONS]

选项

启动 LangGraph API 服务器。对于本地测试，需要具有访问 LangGraph 平台封闭 beta 版的 LangSmith API 密钥。生产使用需要许可证密钥。

用法

langgraph up [OPTIONS]

选项

启动 LangGraph API 服务器。对于本地测试，需要具有访问 LangGraph 平台封闭 beta 版的 LangSmith API 密钥。生产使用需要许可证密钥。

用法

npx @langchain/langgraph-cli up [OPTIONS]

选项

生成一个用于构建 LangGraph 平台 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"}'

生成一个用于构建 LangGraph 平台 API 服务器 Docker 镜像的 Dockerfile。

用法

npx @langchain/langgraph-cli dockerfile [OPTIONS] SAVE_PATH

选项

示例：

npx @langchain/langgraph-cli dockerfile -c langgraph.json Dockerfile

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

FROM langchain/langgraphjs-api:20

ADD . /deps/agent

RUN cd /deps/agent && yarn install

ENV LANGSERVE_GRAPHS='{"agent":"./src/react_agent/graph.ts:graph"}'

WORKDIR /deps/agent

RUN (test ! -f /api/langgraph_api/js/build.mts && echo "Prebuild script not found, skipping") || tsx /api/langgraph_api/js/build.mts