openai-core/com.aallam.openai.api.assistant/AssistantRequest

AssistantRequest

@Serializable

data class AssistantRequest(val model: ModelId? = null, val name: String? = null, val description: String? = null, val instructions: String? = null, val tools: List<AssistantTool>? = null, val fileIds: List<FileId>? = null, val metadata: Map<String, String>? = null)

Constructors

AssistantRequest

constructor(model: ModelId? = null, name: String? = null, description: String? = null, instructions: String? = null, tools: List<AssistantTool>? = null, fileIds: List<FileId>? = null, metadata: Map<String, String>? = null)

Properties

description

val description: String? = null

The description of the assistant. Optional. The maximum length is 512 characters.

fileIds

val fileIds: List<FileId>? = null

A list of file IDs attached to this assistant. Optional. Defaults to an empty list. There can be a maximum of 20 files attached to the assistant.

instructions

val instructions: String? = null

The system instructions that the assistant uses. Optional. The maximum length is 32768 characters.

metadata

val metadata: Map<String, String>? = null

Set of 16 key-value pairs that can be attached to an object. Optional. Keys can be a maximum of 64 characters long, and values can be a maximum of 512 characters long.

model

val model: ModelId? = null

ID of the model to use. This is required if the assistant does not yet exist.

name

val name: String? = null

The name of the assistant. Optional. The maximum length is 256 characters.

tools

val tools: List<AssistantTool>? = null

A list of tools enabled on the assistant. Optional. Defaults to an empty list. Tools can be of types code_interpreter, retrieval, or function.