runs | R Documentation |
runs Class
runs Class
openaistream::openai
-> runs
create()
Create a run.
runs$create(thread_id, assistant_id, ..., verbosity = 0)
thread_id
character Required. The ID of the thread to run.
assistant_id
character Required. The ID of the assistant to use to execute this run.
...
Additional parameters as required by the OpenAI API.For example:model,instructions,tools,metadata
verbosity
numeric Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.)
A run object.
retrieve()
Retrieves a run.
runs$retrieve(thread_id, run_id, verbosity = 0)
thread_id
character Required The ID of the thread the run belongs to.
run_id
character Required The ID of the run to retrieve.
verbosity
numeric Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.)
The run object matching the specified ID.
modify()
Modifies a run.
runs$modify(thread_id, run_id, ..., verbosity = 0)
thread_id
character Required The ID of the thread the run belongs to.
run_id
character Required The ID of the run to retrieve.
...
Additional parameters as required by the OpenAI API.
verbosity
numeric Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.)
The modified run object matching the specified ID.
list()
Returns a list of runs for a given thread.
runs$list(thread_id, ..., verbosity = 0)
thread_id
character Required The ID of the thread the run belongs to.
...
Additional parameters as required by the OpenAI API.
verbosity
numeric Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.)
A list of run objects.
submit_tool_outputs()
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.
runs$submit_tool_outputs(thread_id, run_id, tool_outputs, verbosity = 0)
thread_id
character Required The ID of the thread the run belongs to.
run_id
character Required The ID of the run to retrieve.
tool_outputs
character Required. A list of tools for which the outputs are being submitted.
verbosity
numeric Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.)
The modified run object matching the specified ID.
cancel()
Cancels a run that is in_progress.
runs$cancel(thread_id, run_id, verbosity = 0)
thread_id
character Required The ID of the thread the run belongs to.
run_id
character Required The ID of the run to retrieve.
verbosity
numeric Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.)
The modified run object matching the specified ID.
create_tread()
Create a thread and run it in one request.
runs$create_tread(assistant_id, ..., verbosity = 0)
assistant_id
character Required The ID of the assistant to use to execute this run.
...
Additional parameters as required by the OpenAI API.
verbosity
numeric Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.)
A run object.
steps_retrieve()
Retrieves a run step.
runs$steps_retrieve(thread_id, run_id, step_id, verbosity = 0)
thread_id
character Required. The ID of the thread to which the run and run step belongs.
run_id
character Required. The ID of the run the step belongs to.
step_id
character Required. The ID of the step to retrieve.
verbosity
numeric. Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.)
The run step object matching the specified ID.
steps_list()
Returns a list of run steps belonging to a run.
runs$steps_list(thread_id, run_id, ..., verbosity = 0)
thread_id
character Required The ID of the thread the run belongs to.
run_id
character Required The ID of the run the step belongs to.
...
Additional parameters as required by the OpenAI API.
verbosity
numeric Verbosity level for the API call(0:no output;1:show headers; 2:show headers and bodies;3: show headers, bodies, and curl status messages.)
A list of run step objects.
clone()
The objects of this class are cloneable with this method.
runs$clone(deep = FALSE)
deep
Whether to make a deep clone.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.