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

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

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

Deprecated.

The Assistants API is deprecated in favor of the Responses API

See #submit_tool_outputs_stream_raw for streaming counterpart.

Some parameter documentations has been truncated, see Models::Beta::Threads::RunSubmitToolOutputsParams for more details.

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.

See Also:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/openai/resources/beta/threads/runs.rb', line 313

def submit_tool_outputs(run_id, params)
  parsed, options = OpenAI::Beta::Threads::RunSubmitToolOutputsParams.dump_request(params)
  if parsed[:stream]
    message = "Please use `#submit_tool_outputs_stream_raw` for the streaming use case."
    raise ArgumentError.new(message)
  end
  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/submit_tool_outputs", thread_id, run_id],
    body: parsed,
    model: OpenAI::Beta::Threads::Run,
    options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
  )
end