接口 RunsInvokePayload

interface RunsInvokePayload {
    afterSeconds?: number;
    checkpoint?: Omit<Checkpoint, "thread_id">;
    checkpointDuring?: boolean;
    checkpointId?: string;
    command?: Command;
    config?: Config;
    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? 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

运行的额外配置。

可选 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。

设置

成员可见性

主题

本页内容

afterSecondscheckpointcheckpointDuringcheckpointIdcommandconfigifNotExistsinputinterruptAfterinterruptBeforemetadatamultitaskStrategyonCompletiononDisconnectonRunCreatedsignalwebhook