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

Assistant

@Serializable

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

Constructors

Assistant

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

Properties

createdAt

val createdAt: Long

The Unix timestamp (in seconds) for when the assistant was created.

description

val description: String? = null

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

fileIds

val fileIds: List<FileId>

A list of file IDs attached to this assistant. There can be a maximum of 20 files attached to the assistant. Files are ordered by their creation date in ascending order.

val id: AssistantId

The identifier, which can be referenced in API endpoints.

instructions

val instructions: String? = null

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

metadata

val 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

val model: ModelId

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

name

val name: String

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

tools

val tools: List<AssistantTool>

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types CodeInterpreterTool, RetrievalTool, or FunctionTool.