openai-core/com.aallam.openai.api.run/RunRequestBuilder

RunRequestBuilder

class RunRequestBuilder

Builder for RunRequest.

Constructors

RunRequestBuilder

constructor()

Properties

additionalInstructions

var additionalInstructions: String?

Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.

assistantId

var assistantId: AssistantId?

The ID of the assistant to use to execute this run.

instructions

var instructions: String?

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

metadata

var metadata: Map<String, String>?

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 maximum of 512 characters long.

model

var model: ModelId?

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

var tools: List<AssistantTool>?

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

Functions

build

fun build(): RunRequest

Build a RunRequest instance.