Method: OpenAI::Resources::Beta::Threads::Runs#cancel

Defined in:
lib/openai/resources/beta/threads/runs.rb

#cancel(run_id, thread_id: , request_options: {}) ⇒ OpenAI::Models::Beta::Threads::Run

Deprecated.

The Assistants API is deprecated in favor of the Responses API

Cancels a run that is in_progress.

Parameters:

  • run_id (String) —

    The ID of the run to cancel.

  • thread_id (String) —

    The ID of the thread to which this run belongs.

  • request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/openai/resources/beta/threads/runs.rb', line 273

def cancel(run_id, params)
  parsed, options = OpenAI::Beta::Threads::RunCancelParams.dump_request(params)
  thread_id =
    parsed.delete(:thread_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["threads/%1$s/runs/%2$s/cancel", thread_id, run_id],
    model: OpenAI::Beta::Threads::Run,
    options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
  )
end