类 RunsClient<TStateType, TUpdateType, TCustomEventType>

类型参数

继承关系

  • BaseClient
    • RunsClient

构造函数

构造函数

属性

apiUrl asyncCaller defaultHeaders onRequest? timeoutMs

方法

取消 创建 批量创建 删除 获取 获取 等待完成 流式等待 列出 准备获取选项 流式操作 等待

构造函数

构造函数

属性

受保护 apiUrl

apiUrl: string

受保护 asyncCaller

asyncCaller: AsyncCaller

受保护 defaultHeadersdefaultHeaders

defaultHeaders: Record<string, HeaderValue>

受保护 可选 onRequest

onRequest?: RequestHook

受保护 timeoutMs

timeoutMs: undefined | number

方法

取消

  • cancel(threadId, runId, wait?, action?): Promise<void>

  • 取消一次运行。

    参数

    • threadId: string

      线程的 ID。

    • runId: string

      运行的 ID。

    • 可选 wait: boolean

      取消时是否阻塞

    • 可选 action: CancelAction

      取消运行时要采取的操作。可能的值为 interrupt 或 rollback。默认为 interrupt。

    返回 Promise<void>

创建

  • create(threadId, assistantId, payload?): Promise<Run>

  • 创建一次运行。

    参数

    • threadId: string

      线程的 ID。

    • assistantId: string

      用于此运行的助手 ID。

    • 可选 payload: RunsCreatePayload

      用于创建运行的载荷。

    返回 Promise<Run>

    创建的运行。

批量创建

  • createBatch(payloads): Promise<Run[]>

  • 创建一批无状态后台运行。

    参数

    • payloads: (RunsCreatePayload & {
          assistantId: string;
      })[]

      用于创建运行的载荷数组。

    返回 Promise<Run[]>

    创建的运行数组。

删除

  • delete(threadId, runId): Promise<void>

  • 删除运行。

    参数

    • threadId: string

      线程的 ID。

    • runId: string

      运行的 ID。

    返回 Promise<void>

受保护 获取

  • fetch<T>(path, options): Promise<[T, Response]>

  • 类型参数

    • T

    参数

    • path: string
    • options: RequestInit & {
          json?: unknown;
          params?: Record<string, unknown>;
          signal?: AbortSignal;
          timeoutMs?: null | number;
          withResponse: true;
      }

    返回 Promise<[T, Response]>

  • fetch<T>(path, options?): Promise<T>

  • 类型参数

    • T

    参数

    • path: string
    • 可选 options: RequestInit & {
          json?: unknown;
          params?: Record<string, unknown>;
          signal?: AbortSignal;
          timeoutMs?: null | number;
          withResponse?: false;
      }

    返回 Promise<T>

获取

  • get(threadId, runId): Promise<Run>

  • 按 ID 获取运行。

    参数

    • threadId: string

      线程的 ID。

    • runId: string

      运行的 ID。

    返回 Promise<Run>

    运行。

等待完成

  • join(threadId, runId, options?): Promise<void>

  • 阻塞直到运行完成。

    参数

    • threadId: string

      线程的 ID。

    • runId: string

      运行的 ID。

    • 可选 options: {
          signal?: AbortSignal;
      }
      • 可选 signal?: AbortSignal

    返回 Promise<void>

流式等待

  • joinStream(threadId, runId, options?): AsyncGenerator<{
        data: any;
        event: StreamEvent;
        id?: string;
    }, any, any>

  • 实时流式输出运行结果，直到运行完成。

    参数

    • threadId: undefined | null | string

      线程的 ID。对于无状态运行，可以设置为 null 或 undefined。

    • runId: string

      运行的 ID。

    • 可选 options: AbortSignal | {
          cancelOnDisconnect?: boolean;
          lastEventId?: string;
          signal?: AbortSignal;
          streamMode?: StreamMode | StreamMode[];
      }

      控制流行为的额外选项

      • signal: 可用于取消流请求的 AbortSignal。
      • lastEventId: 接收到的最后一个事件的 ID。可用于重新连接流而不会丢失事件。
      • cancelOnDisconnect: 如果为 true，当客户端与流断开连接时，自动取消运行。
      • streamMode: 控制从流接收的事件类型（可以是单一模式或模式数组）。必须是创建运行时传递的流模式的子集。后台运行默认启用所有流模式的并集。

    返回 AsyncGenerator<{
        data: any;
        event: StreamEvent;
        id?: string;
    }, any, any>

    产生流部分的异步生成器。

列出

  • list(threadId, options?): Promise<Run[]>

  • 列出线程的所有运行。

    参数

    • threadId: string

      线程的 ID。

    • 可选 options: {
          limit?: number;
          offset?: number;
          status?: RunStatus;
      }

      过滤和分页选项。

      • 可选 limit?: number

        要返回的最大运行数量。默认为 10。

      • 可选 offset?: number

        起始偏移量。默认为 0。

      • 可选 status?: RunStatus

        用于过滤的运行状态。

    返回 Promise<Run[]>

    运行列表。

受保护 准备获取选项

  • prepareFetchOptions(path, options?): [url: URL, init: RequestInit]

  • 参数

    • path: string
    • 可选 options: RequestInit & {
          json?: unknown;
          params?: Record<string, unknown>;
          timeoutMs?: null | number;
          withResponse?: boolean;
      }

    返回 [url: URL, init: RequestInit]

流式操作

等待

  • wait(threadId, assistantId, payload?): Promise<DefaultValues>

  • 参数

    • threadId: null
    • assistantId: string
    • 可选 payload: Omit<RunsWaitPayload, "multitaskStrategy" | "onCompletion">

    返回 Promise<DefaultValues>

  • wait(threadId, assistantId, payload?): Promise<DefaultValues>

  • 参数

    • threadId: string
    • assistantId: string
    • 可选 payload: RunsWaitPayload

    返回 Promise<DefaultValues>

设置

成员可见性

主题

本页内容

构造函数apiUrlasyncCallerdefaultHeadersonRequesttimeoutMs取消创建批量创建删除获取获取等待完成流式等待列出准备获取选项流式操作等待