类 CronsClient

继承关系

  • BaseClient
    • CronsClient

构造函数

构造函数

属性

apiUrl asyncCaller defaultHeaders onRequest? timeoutMs

方法

create createForThread delete fetch prepareFetchOptions search

构造函数

构造函数

属性

受保护 apiUrl

apiUrl: string

受保护 asyncCaller

asyncCaller: AsyncCaller

受保护 defaultHeadersdefaultHeaders

defaultHeaders: Record<string, HeaderValue>

受保护的 可选的 onRequest

onRequest?: RequestHook

受保护 timeoutMs

timeoutMs: undefined | number

方法

创建

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

  • 参数

    • assistantId: string

      用于此 cron 任务的助手 ID。

    • 可选的 payload: CronsCreatePayload

      用于创建 cron 任务的载荷。

    返回 Promise<CronCreateResponse>

createForThread

  • createForThread(threadId, assistantId, payload?): Promise<CronCreateForThreadResponse>

  • 参数

    • threadId: string

      线程的 ID。

    • assistantId: string

      用于此 cron 任务的助手 ID。

    • 可选的 payload: CronsCreatePayload

      用于创建 cron 任务的载荷。

    返回 Promise<CronCreateForThreadResponse>

    创建的后台运行。

删除

  • delete(cronId): Promise<void>

  • 参数

    • cronId: string

      要删除的 Cron 任务的 Cron 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>

受保护的 prepareFetchOptions

  • 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]

search

  • search(query?): Promise<Cron[]>

  • 参数

    • 可选的 query: {
          assistantId?: string;
          limit?: number;
          offset?: number;
          sortBy?: CronSortBy;
          sortOrder?: SortOrder;
          threadId?: string;
      }

      查询选项。

      • 可选的 assistantId?: string
      • 可选 limit?: number
      • 可选 offset?: number
      • 可选的 sortBy?: CronSortBy
      • 可选的 sortOrder?: SortOrder
      • 可选的 threadId?: string

    返回 Promise<Cron[]>

    cron 任务列表。

设置

成员可见性

主题

本页内容

构造函数apiUrlasyncCallerdefaultHeadersonRequesttimeoutMscreatecreateForThreaddeletefetchprepareFetchOptionssearch