Class RunsClient<TStateType, TUpdateType, TCustomEventType>

Type Parameters

TStateType = DefaultValues
TUpdateType = TStateType
TCustomEventType = unknown

Hierarchy

BaseClient
- RunsClient

Index

Constructors

constructor

new RunsClient<
    TStateType = DefaultValues,
    TUpdateType = TStateType,
    TCustomEventType = unknown,
>(
    config?: ClientConfig,
): RunsClient<TStateType, TUpdateType, TCustomEventType>
Type Parameters
- TStateType = DefaultValues
- TUpdateType = TStateType
- TCustomEventType = unknown
Parameters
- Optionalconfig: ClientConfig
Returns RunsClient<TStateType, TUpdateType, TCustomEventType>
Inherited from BaseClient.constructor
- Defined in client.ts:193

Properties

`Protected`apiUrl

apiUrl: string

`Protected`asyncCaller

asyncCaller: AsyncCaller

`Protected`defaultHeaders

defaultHeaders: Record<string, HeaderValue>

`Protected` `Optional`onRequest

onRequest?: RequestHook

`Protected`timeoutMs

timeoutMs: undefined | number

Methods

cancel

cancel(
    threadId: string,
    runId: string,
    wait?: boolean,
    action?: CancelAction,
): Promise<void>
Cancel a run.
Parameters
- threadId: string
  The ID of the thread.
- runId: string
  The ID of the run.
- wait: boolean = false
  Whether to block when canceling
- action: CancelAction = "interrupt"
  Action to take when cancelling the run. Possible values are interrupt or rollback. Default is interrupt.
Returns Promise<void>
- Defined in client.ts:1387

create

create(
    threadId: string,
    assistantId: string,
    payload?: RunsCreatePayload,
): Promise<Run>
Create a run.
Parameters
- threadId: string
  The ID of the thread.
- assistantId: string
  Assistant ID to use for this run.
- Optionalpayload: RunsCreatePayload
  Payload for creating a run.
Returns Promise<Run>
The created run.
- Defined in client.ts:1180

createBatch

createBatch(
payloads: (RunsCreatePayload & { assistantId: string })[],
): Promise<Run[]>
Create a batch of stateless background runs.
Parameters
- payloads: (RunsCreatePayload & { assistantId: string })[]
  An array of payloads for creating runs.
Returns Promise<Run[]>
An array of created runs.
- Defined in client.ts:1232

delete

delete(threadId: string, runId: string): Promise<void>
Delete a run.
Parameters
- threadId: string
  The ID of the thread.
- runId: string
  The ID of the run.
Returns Promise<void>
- Defined in client.ts:1493

`Protected`fetch

fetch<T>(
    path: string,
    options: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        signal?: AbortSignal;
        timeoutMs?: null | number;
        withResponse: true;
    },
): Promise<[T, Response]>
Type Parameters
- T
Parameters
- path: string
- options: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      signal?: AbortSignal;
      timeoutMs?: null | number;
      withResponse: true;
  }
Returns Promise<[T, Response]>
Inherited from BaseClient.fetch
- Defined in client.ts:288
fetch<T>(
    path: string,
    options?: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        signal?: AbortSignal;
        timeoutMs?: null | number;
        withResponse?: false;
    },
): Promise<T>
Type Parameters
- T
Parameters
- path: string
- Optionaloptions: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      signal?: AbortSignal;
      timeoutMs?: null | number;
      withResponse?: false;
  }
Returns Promise<T>
Inherited from BaseClient.fetch
- Defined in client.ts:299

get

get(threadId: string, runId: string): Promise<Run>
Get a run by ID.
Parameters
- threadId: string
  The ID of the thread.
- runId: string
  The ID of the run.
Returns Promise<Run>
The run.
- Defined in client.ts:1374

join

join(
    threadId: string,
    runId: string,
    options?: { signal?: AbortSignal },
): Promise<TStateType>
Block until a run is done.
Parameters
- threadId: string
  The ID of the thread.
- runId: string
  The ID of the run.
- Optionaloptions: { signal?: AbortSignal }
Returns Promise<TStateType>
- Defined in client.ts:1409

joinStream

joinStream(
    threadId: undefined | null | string,
    runId: string,
    options?:
        | AbortSignal
        | {
            cancelOnDisconnect?: boolean;
            lastEventId?: string;
            signal?: AbortSignal;
            streamMode?: StreamMode
            | StreamMode[];
        },
): AsyncGenerator<{ data: any; event: StreamEvent; id?: string }>
Stream output from a run in real-time, until the run is done.
Parameters
- threadId: undefined | null | string
  The ID of the thread. Can be set to null | undefined for stateless runs.
- runId: string
  The ID of the run.
- Optionaloptions:
      | AbortSignal
      | {
          cancelOnDisconnect?: boolean;
          lastEventId?: string;
          signal?: AbortSignal;
          streamMode?: StreamMode
          | StreamMode[];
      }
  Additional options for controlling the stream behavior:
  
  signal: An AbortSignal that can be used to cancel the stream request
  
  lastEventId: The ID of the last event received. Can be used to reconnect to a stream without losing events.
  
  cancelOnDisconnect: When true, automatically cancels the run if the client disconnects from the stream
  
  streamMode: Controls what types of events to receive from the stream (can be a single mode or array of modes) Must be a subset of the stream modes passed when creating the run. Background runs default to having the union of all stream modes enabled.
Returns AsyncGenerator<{ data: any; event: StreamEvent; id?: string }>
An async generator yielding stream parts.
- Defined in client.ts:1434

list

list(
    threadId: string,
    options?: {
        limit?: number;
        offset?: number;
        select?: RunSelectField[];
        status?: RunStatus;
    },
): Promise<Run[]>
List all runs for a thread.
Parameters
- threadId: string
  The ID of the thread.
- Optionaloptions: {
      limit?: number;
      offset?: number;
      select?: RunSelectField[];
      status?: RunStatus;
  }
  Filtering and pagination options.
  - Optionallimit?: number
    Maximum number of runs to return. Defaults to 10
  - Optionaloffset?: number
    Offset to start from. Defaults to 0.
  - Optionalselect?: RunSelectField[]
  - Optionalstatus?: RunStatus
    Status of the run to filter by.
Returns Promise<Run[]>
List of runs.
- Defined in client.ts:1335

`Protected`prepareFetchOptions

prepareFetchOptions(
    path: string,
    options?: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        timeoutMs?: null | number;
        withResponse?: boolean;
    },
): [url: URL, init: RequestInit]
Parameters
- path: string
- Optionaloptions: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      timeoutMs?: null | number;
      withResponse?: boolean;
  }
Returns [url: URL, init: RequestInit]
Inherited from BaseClient.prepareFetchOptions
- Defined in client.ts:233

stream

stream<
    TStreamMode extends StreamMode
    | StreamMode[] = StreamMode,
    TSubgraphs extends boolean = false,
>(
    threadId: null,
    assistantId: string,
    payload?: Omit<
        RunsStreamPayload<TStreamMode, TSubgraphs>,
        "multitaskStrategy" | "onCompletion",
    >,
): TypedAsyncGenerator<
    TStreamMode,
    TSubgraphs,
    TStateType,
    TUpdateType,
    TCustomEventType,
>
Type Parameters
- TStreamMode extends StreamMode | StreamMode[] = StreamMode
- TSubgraphs extends boolean = false
Parameters
- threadId: null
- assistantId: string
- Optionalpayload: Omit<
  RunsStreamPayload<TStreamMode, TSubgraphs>,
  "multitaskStrategy" | "onCompletion",
  >
Returns TypedAsyncGenerator<
    TStreamMode,
    TSubgraphs,
    TStateType,
    TUpdateType,
    TCustomEventType,
>
- Defined in client.ts:1068
stream<
    TStreamMode extends StreamMode
    | StreamMode[] = StreamMode,
    TSubgraphs extends boolean = false,
>(
    threadId: string,
    assistantId: string,
    payload?: RunsStreamPayload<TStreamMode, TSubgraphs>,
): TypedAsyncGenerator<
    TStreamMode,
    TSubgraphs,
    TStateType,
    TUpdateType,
    TCustomEventType,
>
Type Parameters
- TStreamMode extends StreamMode | StreamMode[] = StreamMode
- TSubgraphs extends boolean = false
Parameters
- threadId: string
- assistantId: string
- Optionalpayload: RunsStreamPayload<TStreamMode, TSubgraphs>
Returns TypedAsyncGenerator<
    TStreamMode,
    TSubgraphs,
    TStateType,
    TUpdateType,
    TCustomEventType,
>
- Defined in client.ts:1086

wait

wait(
    threadId: null,
    assistantId: string,
    payload?: Omit<RunsWaitPayload, "multitaskStrategy" | "onCompletion">,
): Promise<DefaultValues>
Parameters
- threadId: null
- assistantId: string
- Optionalpayload: Omit<RunsWaitPayload, "multitaskStrategy" | "onCompletion">
Returns Promise<DefaultValues>
- Defined in client.ts:1249
wait(
    threadId: string,
    assistantId: string,
    payload?: RunsWaitPayload,
): Promise<DefaultValues>
Parameters
- threadId: string
- assistantId: string
- Optionalpayload: RunsWaitPayload
Returns Promise<DefaultValues>
- Defined in client.ts:1255

Class RunsClient<TStateType, TUpdateType, TCustomEventType>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RunsClient<TStateType, TUpdateType, TCustomEventType>

Properties

ProtectedapiUrl

ProtectedasyncCaller

ProtecteddefaultHeaders

Protected OptionalonRequest

ProtectedtimeoutMs

Methods

cancel

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<Run>

createBatch

Parameters

Returns Promise<Run[]>

delete

Parameters

Returns Promise<void>

Protectedfetch

Type Parameters

Parameters

Returns Promise<[T, Response]>

Type Parameters

Parameters

Returns Promise<T>

get

Parameters

Returns Promise<Run>

join

Parameters

Returns Promise<TStateType>

joinStream

Parameters

Returns AsyncGenerator<{ data: any; event: StreamEvent; id?: string }>

list

Parameters

Optionallimit?: number

Optionaloffset?: number

Optionalselect?: RunSelectField[]

Optionalstatus?: RunStatus

Returns Promise<Run[]>

ProtectedprepareFetchOptions

Parameters

Returns [url: URL, init: RequestInit]

stream

Type Parameters

Parameters

Returns TypedAsyncGenerator< TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType,>

Type Parameters

Parameters

Returns TypedAsyncGenerator< TStreamMode, TSubgraphs, TStateType, TUpdateType, TCustomEventType,>

wait

Parameters

Returns Promise<DefaultValues>

Parameters

Returns Promise<DefaultValues>

Settings

On This Page

`Protected`apiUrl

`Protected`asyncCaller

`Protected`defaultHeaders

`Protected` `Optional`onRequest

`Protected`timeoutMs

`Protected`fetch

`Optional`limit?: number

`Optional`offset?: number

`Optional`select?: RunSelectField[]

`Optional`status?: RunStatus

`Protected`prepareFetchOptions

Returns TypedAsyncGenerator<
TStreamMode,
TSubgraphs,
TStateType,
TUpdateType,
TCustomEventType,
>

Returns TypedAsyncGenerator<
TStreamMode,
TSubgraphs,
TStateType,
TUpdateType,
TCustomEventType,
>