Class Runs

constructor

• new Runs(client): OpenAIClient.Beta.Threads.Runs

• Parameters

  • client: OpenAI

  Returns OpenAIClient.Beta.Threads.Runs

steps

cancel

• cancel(threadId, runId, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

• Cancels a run that is in_progress.

  Parameters

  • threadId: string
  • runId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

create

• create(threadId, params, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

• Create a run.

  Parameters

  • threadId: string
  • params: OpenAIClient.Beta.Threads.Runs.RunCreateParamsNonStreaming
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run>
• create(threadId, params, options?): APIPromise<Stream<AssistantStreamEvent>>

• Parameters

  • threadId: string
  • params: OpenAIClient.Beta.Threads.Runs.RunCreateParamsStreaming
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Stream<AssistantStreamEvent>>

• create(threadId, params, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run | Stream<AssistantStreamEvent>>

• Parameters

  • threadId: string
  • params: RunCreateParamsBase
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run | Stream<AssistantStreamEvent>>

createAndPoll

• createAndPoll(threadId, body, options?): Promise<OpenAIClient.Beta.Threads.Runs.Run>

• A helper to create a run an poll for a terminal state. More information on Run lifecycles can be found here: https://platform.openai.com/docs/assistants/how-it-works/runs-and-run-steps

  Parameters

  • threadId: string
  • body: OpenAIClient.Beta.Threads.Runs.RunCreateParamsNonStreaming
  • Optionaloptions: RequestOptions<unknown> & {
        pollIntervalMs?: number;
    }

  Returns Promise<OpenAIClient.Beta.Threads.Runs.Run>

createAndStream

• createAndStream(threadId, body, options?): AssistantStream

• Create a Run stream

  Parameters

  • threadId: string
  • body: RunCreateParamsBaseStream
  • Optionaloptions: RequestOptions<unknown>

  Returns AssistantStream

  Deprecated

  use stream instead

list

• list(threadId, query?, options?): PagePromise<RunsPage, OpenAIClient.Beta.Threads.Runs.Run>

• Returns a list of runs belonging to a thread.

  Parameters

  • threadId: string
  • Optionalquery: OpenAIClient.Beta.Threads.Runs.RunListParams
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<RunsPage, OpenAIClient.Beta.Threads.Runs.Run>
• list(threadId, options?): PagePromise<RunsPage, OpenAIClient.Beta.Threads.Runs.Run>

• Parameters

  • threadId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<RunsPage, OpenAIClient.Beta.Threads.Runs.Run>

poll

• poll(threadId, runId, options?): Promise<OpenAIClient.Beta.Threads.Runs.Run>

• A helper to poll a run status until it reaches a terminal state. More information on Run lifecycles can be found here: https://platform.openai.com/docs/assistants/how-it-works/runs-and-run-steps

  Parameters

  • threadId: string
  • runId: string
  • Optionaloptions: RequestOptions<unknown> & {
        pollIntervalMs?: number;
    }

  Returns Promise<OpenAIClient.Beta.Threads.Runs.Run>

retrieve

• retrieve(threadId, runId, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

• Retrieves a run.

  Parameters

  • threadId: string
  • runId: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

stream

• stream(threadId, body, options?): AssistantStream

• Create a Run stream

  Parameters

  • threadId: string
  • body: RunCreateParamsBaseStream
  • Optionaloptions: RequestOptions<unknown>

  Returns AssistantStream

submitToolOutputs

• submitToolOutputs(threadId, runId, body, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

• When a run has the status: "requires_action" and required_action.type is submit_tool_outputs, this endpoint can be used to submit the outputs from the tool calls once they're all completed. All outputs must be submitted in a single request.

  Parameters

  • threadId: string
  • runId: string
  • body: OpenAIClient.Beta.Threads.Runs.RunSubmitToolOutputsParamsNonStreaming
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run>
• submitToolOutputs(threadId, runId, body, options?): APIPromise<Stream<AssistantStreamEvent>>

• Parameters

  • threadId: string
  • runId: string
  • body: OpenAIClient.Beta.Threads.Runs.RunSubmitToolOutputsParamsStreaming
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Stream<AssistantStreamEvent>>

• submitToolOutputs(threadId, runId, body, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run | Stream<AssistantStreamEvent>>

• Parameters

  • threadId: string
  • runId: string
  • body: RunSubmitToolOutputsParamsBase
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run | Stream<AssistantStreamEvent>>

submitToolOutputsAndPoll

• submitToolOutputsAndPoll(threadId, runId, body, options?): Promise<OpenAIClient.Beta.Threads.Runs.Run>

• A helper to submit a tool output to a run and poll for a terminal run state. More information on Run lifecycles can be found here: https://platform.openai.com/docs/assistants/how-it-works/runs-and-run-steps

  Parameters

  • threadId: string
  • runId: string
  • body: OpenAIClient.Beta.Threads.Runs.RunSubmitToolOutputsParamsNonStreaming
  • Optionaloptions: RequestOptions<unknown> & {
        pollIntervalMs?: number;
    }

  Returns Promise<OpenAIClient.Beta.Threads.Runs.Run>

submitToolOutputsStream

• submitToolOutputsStream(threadId, runId, body, options?): AssistantStream

• Submit the tool outputs from a previous run and stream the run to a terminal state. More information on Run lifecycles can be found here: https://platform.openai.com/docs/assistants/how-it-works/runs-and-run-steps

  Parameters

  • threadId: string
  • runId: string
  • body: RunSubmitToolOutputsParamsStream
  • Optionaloptions: RequestOptions<unknown>

  Returns AssistantStream

update

• update(threadId, runId, body, options?): APIPromise<OpenAIClient.Beta.Threads.Runs.Run>

• Modifies a run.

  Parameters

  • threadId: string
  • runId: string
  • body: RunUpdateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<OpenAIClient.Beta.Threads.Runs.Run>