使用 cron 作业

在许多情况下，按计划运行助手都非常有用。例如，假设你正在构建一个每天运行并发送当天新闻摘要邮件的助手。你可以使用 cron 作业，让助手每天晚上 8:00 运行。 LangSmith Deployment 支持 cron 作业，这些作业会按照用户定义的计划运行。用户需要指定计划、助手以及一些输入。之后，服务器会按照指定的计划：

使用指定的助手创建一个新线程
将指定的输入发送到该线程

请注意，每次发送到线程的输入都是相同的。 LangSmith Deployment API 提供了多个用于创建和管理 cron 作业的端点。有关更多详细信息，请参阅 API 参考。有时你不希望根据用户交互来运行图，而是希望按照计划运行图——例如，你可能希望图每周整理并发送一封包含团队待办事项的邮件。LangSmith Deployment 允许你使用 Crons 客户端完成此操作，而无需编写自己的脚本。要计划图作业，你需要传入一个 cron 表达式，以告知客户端何时运行图。Cron 作业会在后台运行，不会干扰图的正常调用。

所有 cron 计划都按照 UTC 解释。指定计划时，请务必将所需的执行时间转换为 UTC。

设置

首先，让我们设置 SDK 客户端、助手和线程：

Python
Javascript
cURL

from langgraph_sdk import get_client

client = get_client(url=<DEPLOYMENT_URL>)
# 使用以 "agent" 名称部署的图
assistant_id = "agent"
# 创建线程
thread = await client.threads.create()
print(thread)

import { Client } from "@langchain/langgraph-sdk";

const client = new Client({ apiUrl: <DEPLOYMENT_URL> });
// 使用以 "agent" 名称部署的图
const assistantId = "agent";
// 创建线程
const thread = await client.threads.create();
console.log(thread);

curl --request POST \
    --url <DEPLOYMENT_URL>/assistants/search \
    --header 'Content-Type: application/json' \
    --data '{
        "limit": 10,
        "offset": 0
    }' | jq -c 'map(select(.config == null or .config == {})) | .[0].graph_id' && \
curl --request POST \
    --url <DEPLOYMENT_URL>/threads \
    --header 'Content-Type: application/json' \
    --data '{}'

输出：

{
'thread_id': '9dde5490-2b67-47c8-aa14-4bfec88af217',
'created_at': '2024-08-30T23:07:38.242730+00:00',
'updated_at': '2024-08-30T23:07:38.242730+00:00',
'metadata': {},
'status': 'idle',
'config': {},
'values': None
}

在线程上创建 cron 作业

要创建与特定线程关联的 cron 作业，可以编写：

Python
Javascript
cURL

# 计划一个每天在 UTC 时间 15:27（下午 3:27）运行的作业
cron_job = await client.crons.create_for_thread(
    thread["thread_id"],
    assistant_id,
    schedule="27 15 * * *",
    input={"messages": [{"role": "user", "content": "现在几点？"}]},
)

// 计划一个每天在 UTC 时间 15:27（下午 3:27）运行的作业
const cronJob = await client.crons.create_for_thread(
  thread["thread_id"],
  assistantId,
  {
    schedule: "27 15 * * *",
    input: { messages: [{ role: "user", "content": "现在几点？" }] }
  }
);

curl --request POST \
    --url <DEPLOYMENT_URL>/threads/<THREAD_ID>/runs/crons \
    --header 'Content-Type: application/json' \
    --data '{
        "assistant_id": <ASSISTANT_ID>,
    }'

请注意，删除不再有用的 Cron 作业非常重要。否则，你可能会产生不必要的 LLM API 费用！你可以使用以下代码删除 Cron 作业：

Python
Javascript
cURL

await client.crons.delete(cron_job["cron_id"])

await client.crons.delete(cronJob["cron_id"]);

curl --request DELETE \
    --url <DEPLOYMENT_URL>/runs/crons/<CRON_ID>

无状态 cron 作业

你也可以使用以下代码创建无状态 cron 作业。无状态 cron 作业会在每次执行时创建一个新线程：

Python
Javascript
cURL

# 计划一个每天在 UTC 时间 15:27（下午 3:27）运行的作业
cron_job_stateless = await client.crons.create(
    assistant_id,
    schedule="27 15 * * *",
    input={"messages": [{"role": "user", "content": "现在几点？"}]},
)

// 计划一个每天在 UTC 时间 15:27（下午 3:27）运行的作业
const cronJobStateless = await client.crons.create(
  assistantId,
  {
    schedule: "27 15 * * *",
    input: { messages: [{ role: "user", content: "现在几点了？" }] }
  }
);

curl --request POST \
    --url <DEPLOYMENT_URL>/runs/crons \
    --header 'Content-Type: application/json' \
    --data '{
        "assistant_id": <ASSISTANT_ID>,
    }'

再次提醒，完成后请记得删除作业！

Python
Javascript
cURL

await client.crons.delete(cron_job_stateless["cron_id"])

await client.crons.delete(cronJobStateless["cron_id"]);

curl --request DELETE \
    --url <DEPLOYMENT_URL>/runs/crons/<CRON_ID>

无状态 cron 的线程清理

此功能需要 LangGraph API 0.5.18 或更高版本，以及 Python SDK 0.3.2 或更高版本，或 JavaScript SDK 1.4.0 或更高版本。

每次触发无状态 cron 时，都会创建一个新线程。你可以使用 on_run_completed 参数控制运行完成后该线程的处理方式：

"delete"（默认）：运行完成后自动删除线程。
"keep"：保留线程，以便稍后检索。你需要负责清理这些线程。有关推荐方法，请参阅如何为应用添加 TTL。

示例：保留线程以便稍后检索

Python
Javascript
cURL

# 创建一个在执行后保留线程的无状态 cron。
# 在 langgraph.json 中配置 checkpointer.ttl，以自动删除旧线程。
# 参见：https://docs.langchain.com/langsmith/configure-ttl
cron_job = await client.crons.create(
    assistant_id,
    schedule="27 15 * * *",
    input={"messages": [{"role": "user", "content": "每日报告"}]},
    on_run_completed="keep"
)

# 之后，你可以检索运行记录及其结果
runs = await client.runs.search(
    metadata={"cron_id": cron_job["cron_id"]}
)

// 创建一个在执行后保留线程的无状态 cron。
// 在 langgraph.json 中配置 checkpointer.ttl，以自动删除旧线程。
// 参见：https://docs.langchain.com/langsmith/configure-ttl
const cronJob = await client.crons.create(
  assistantId,
  {
    schedule: "27 15 * * *",
    input: { messages: [{ role: "user", content: "每日报告" }] },
    onRunCompleted: "keep"
  }
);

// 之后，你可以检索运行记录及其结果
const runs = await client.runs.search({
  metadata: { cron_id: cronJob["cron_id"] }
});

# 创建一个在执行后保留线程的无状态 cron。
# 在 langgraph.json 中配置 checkpointer.ttl，以自动删除旧线程。
# 参见：https://docs.langchain.com/langsmith/configure-ttl
curl --request POST \
    --url <DEPLOYMENT_URL>/runs/crons \
    --header 'Content-Type: application/json' \
    --data '{
        "assistant_id": "<ASSISTANT_ID>",
        "schedule": "27 15 * * *",
        "input": {"messages": [{"role": "user", "content": "每日报告"}]},
        "on_run_completed": "keep"
    }'

Connect these docs to Claude, VSCode, and more via MCP for real-time answers.

Edit this page on GitHub or file an issue.

Develop your application

Capabilities

How to build

Auth & access control

Server customization

设置

在线程上创建 cron 作业

无状态 cron 作业

无状态 cron 的线程清理

示例：保留线程以便稍后检索

​设置

​在线程上创建 cron 作业

​无状态 cron 作业

​无状态 cron 的线程清理

​示例：保留线程以便稍后检索

设置

在线程上创建 cron 作业

无状态 cron 作业

无状态 cron 的线程清理

示例：保留线程以便稍后检索