runs_submit_tool_outputs_request: API runs: submit tool outputs to run

In oaii: 'OpenAI' API R Interface

API runs: submit tool outputs to run

Description

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. To get more details, visit https://platform.openai.com/docs/api-reference/runs/submitToolOutputs https://platform.openai.com/docs/assistants

Usage

runs_submit_tool_outputs_request(
  thread_id,
  run_id,
  tool_outputs,
  api_key = api_get_key()
)

Arguments

thread_id	string, the ID of the thread (https://platform.openai.com/docs/api-reference/threads) to which this run belongs
run_id	string, the ID of the run that requires the tool output submission
tool_outputs	list, a list of tools for which the outputs are being submitted. list( # string (optional), the ID of the tool call in the required_action # object within the run object the output is being submitted for. tool_call_id = # string (optional), the output of the tool call to be # submitted to continue the run output = )
api_key	string, OpenAI API key (see https://platform.openai.com/account/api-keys)

Value

content of the httr response object or SimpleError (conditions) enhanced with two additional fields: 'status_code' (response$status_code) and 'message_long' (built on response content)

oaii documentation built on May 29, 2024, 5:25 a.m.