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

ThreadRunRequest

@Serializable
data class ThreadRunRequest(val assistantId: AssistantId, val thread: ThreadRequest? = null, val model: ModelId? = null, val instructions: String? = null, val tools: List<AssistantTool>? = null, val metadata: Map<String, String>? = null)

Create a thread and run it in one request.

Constructors

Link copied to clipboard
constructor(assistantId: AssistantId, thread: ThreadRequest? = null, model: ModelId? = null, instructions: String? = null, tools: List<AssistantTool>? = null, metadata: Map<String, String>? = null)

Properties

Link copied to clipboard
@SerialName(value = "assistant_id")
val assistantId: AssistantId

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

Link copied to clipboard
@SerialName(value = "instructions")
val instructions: String? = null

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

Link copied to clipboard
@SerialName(value = "metadata")
val metadata: Map<String, String>? = null

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.

Link copied to clipboard
@SerialName(value = "model")
val model: ModelId? = 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.

Link copied to clipboard
@SerialName(value = "thread")
val thread: ThreadRequest? = null

Thread to be executed.

Link copied to clipboard
@SerialName(value = "tools")
val tools: List<AssistantTool>? = null

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