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

Package-level declarations

Types

@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>)

data class AssistantFile(val id: FileId, val createdAt: Int, val assistantId: AssistantId)

File attached to an assistant.

@Serializable

value class AssistantId(val id: String)

ID of an assistant.

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)

AssistantRequestBuilder

class AssistantRequestBuilder

@Serializable

interface AssistantTool

Tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, retrieval, or function.

@Serializable

data class Function(val name: String, val description: String, val parameters: Parameters)

FunctionBuilder

class FunctionBuilder

Builder of Function instances.

Functions

assistantRequest

fun assistantRequest(block: AssistantRequestBuilder.() -> Unit): AssistantRequest

Creates AssistantRequest instance.

fun function(block: FunctionBuilder.() -> Unit): Function

Creates Function instance.