Package version:

Interface RunsOperations

Interface representing a Runs operations.

interface RunsOperations {
    cancel: ((threadId: string, runId: string, options?: RunsCancelRunOptionalParams) => Promise<ThreadRun>);
    create: ((threadId: string, assistantId: string, options?: RunsCreateRunOptionalParams) => any);
    createThreadAndRun: ((assistantId: string, options?: CreateThreadAndRunOptionalParams) => any);
    get: ((threadId: string, runId: string, options?: RunsGetRunOptionalParams) => Promise<ThreadRun>);
    list: ((threadId: string, options?: RunsListRunsOptionalParams) => PagedAsyncIterableIterator<ThreadRun, {}, PageSettings>);
    submitToolOutputs: ((threadId: string, runId: string, toolOutputs: {}, options?: RunsSubmitToolOutputsToRunOptionalParams) => Promise<ThreadRun>);
    update: ((threadId: string, runId: string, options?: RunsUpdateRunOptionalParams) => Promise<ThreadRun>);
}

Properties

cancel: ((threadId: string, runId: string, options?: RunsCancelRunOptionalParams) => Promise<ThreadRun>)

Cancels a run of an in‐progress thread.

create: ((threadId: string, assistantId: string, options?: RunsCreateRunOptionalParams) => any)

Creates a new run for an agent thread.

createThreadAndRun: ((assistantId: string, options?: CreateThreadAndRunOptionalParams) => any)

Creates a new thread and run for an agent.

get: ((threadId: string, runId: string, options?: RunsGetRunOptionalParams) => Promise<ThreadRun>)

Gets an existing run from an existing thread.

Gets a list of runs for a specified thread.

submitToolOutputs: ((threadId: string, runId: string, toolOutputs: {}, options?: RunsSubmitToolOutputsToRunOptionalParams) => Promise<ThreadRun>)

Submits outputs from tools as requested by tool calls in a run.

update: ((threadId: string, runId: string, options?: RunsUpdateRunOptionalParams) => Promise<ThreadRun>)

Modifies an existing thread run.