接口 RunsInvokePayload

interface RunsInvokePayload {
    afterSeconds?: number;
    checkpoint?: Omit<Checkpoint, "thread_id">;
    checkpointDuring?: boolean;
    checkpointId?: string;
    command?: Command;
    config?: Config;
    context?: unknown;
    ifNotExists?: "reject" | "create";
    input?: null | Record<string, unknown>;
    interruptAfter?: string[] | "*";
    interruptBefore?: string[] | "*";
    metadata?: Metadata;
    multitaskStrategy?: MultitaskStrategy;
    onCompletion?: OnCompletionBehavior;
    onDisconnect?: DisconnectMode;
    onRunCreated?: ((params) => void);
    signal?: AbortSignal;
    webhook?: string;
}

属性

afterSeconds? checkpoint? checkpointDuring? checkpointId? command? config? context? ifNotExists? input? interruptAfter? interruptBefore? metadata? multitaskStrategy? onCompletion? onDisconnect? onRunCreated? signal? webhook?

属性

可选 afterSeconds

afterSeconds?: number

开始运行前等待的秒数。用于安排未来的运行。

可选 checkpoint

checkpoint?: Omit<Checkpoint, "thread_id">

创建新运行时使用的检查点。

可选 checkpointDuring

checkpointDuring?: boolean

是否在运行期间创建检查点（或仅在结束/中断时）。

可选 checkpointId

checkpointId?: string

创建新运行时使用的检查点 ID。

可选 command

command?: Command

用于调用图的一个或多个命令。

可选 config?

config?: Config

运行的附加配置。

可选 context

context?: unknown

要添加到助手的静态上下文。

备注

在 LangGraph.js 0.4 中添加

可选 ifNotExists

ifNotExists?: "reject" | "create"

如果指定的运行不存在时的行为。默认为“reject”。

可选 input

input?: null | Record<string, unknown>

运行的输入。传递 `null` 以从线程的当前状态恢复。

可选 interruptAfter?

interruptAfter?: string[] | "*"

离开这些节点后中断执行。

可选 interruptBefore?

interruptBefore?: string[] | "*"

在进入这些节点前中断执行。

可选 metadata?

metadata?: Metadata

运行的元数据。

可选 multitaskStrategy

multitaskStrategy?: MultitaskStrategy

处理同一线程上并发运行的策略。仅在同一线程上有待处理/正在进行的运行时才相关。以下之一：

  • "reject"：拒绝新的运行。
  • "interrupt"：中断当前运行，保留到目前为止已完成的步骤，并开始一个新的运行。
  • "rollback"：取消并删除现有运行，将线程回滚到其开始前的状态，然后开始新的运行。
  • "enqueue"：将新的运行排队，在当前运行完成后开始。

可选 onCompletion

onCompletion?: OnCompletionBehavior

处理运行完成的行为。仅在同一线程上有待处理/正在进行的运行时才相关。以下之一：

  • "complete"：完成运行。
  • "continue"：继续运行。

可选 onDisconnect

onDisconnect?: DisconnectMode

处理断开连接的行为。仅在同一线程上有待处理/正在进行的运行时才相关。以下之一：

  • "cancel"：取消运行。
  • "continue"：继续运行。

可选 onRunCreated

onRunCreated?: ((params) => void)

创建运行时调用的回调函数。

类型声明

    • (params): void

    • 参数

      • params: {
            run_id: string;
            thread_id?: string;
        }
        • run_id: string
        • 可选 thread_id?: string

      返回 void

可选 signal?

signal?: AbortSignal

用于取消运行的中止控制器信号。

可选 webhook

webhook?: string

运行完成时调用的 Webhook。

设置

成员可见性

主题

本页内容

afterSecondscheckpointcheckpointDuringcheckpointIdcommandconfigcontextifNotExistsinputinterruptAfterinterruptBeforemetadatamultitaskStrategyonCompletiononDisconnectonRunCreatedsignalwebhook