create_run: Create Run - Beta

View source: R/functions.R

create_runR Documentation

Create Run - Beta

Description

Create a run.

Usage

create_run(
  assistant_id,
  thread_id,
  instructions = NULL,
  metadata = NULL,
  model = NULL,
  tools = NULL,
  return_response = F
)

Arguments

assistant_id

(string) The ID of the assistant to use to execute this run. Required

thread_id

(string) The ID of the thread to run. Required

instructions

(string or null) Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.

metadata

(map) Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long.

model

(string or null) The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

tools

(array or null) Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

return_response

(boolean) Whether to return the API response or parse the contents of the response. Defaults to FALSE (parse the response).

See Also

Open AI Documentation


samterfa/openai documentation built on Oct. 9, 2024, 5:18 p.m.