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

Package-level declarations

Types

@Serializable

data class Assistant(val id: AssistantId, val createdAt: Long, val name: String? = null, val description: String? = null, val model: ModelId, val instructions: String? = null, val tools: List<AssistantTool>, val toolResources: ToolResources? = null, val metadata: Map<String, String>, val temperature: Double? = null, val topP: Double? = null, val responseFormat: AssistantResponseFormat? = null)

AssistantId

@Serializable

@JvmInline

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 toolResources: ToolResources? = null, val metadata: Map<String, String>? = null, val temperature: Double? = null, val topP: Double? = null, val responseFormat: AssistantResponseFormat? = null)

AssistantRequestBuilder

class AssistantRequestBuilder

AssistantResponseFormat

@Serializable(with = AssistantResponseFormat.ResponseFormatSerializer::class)

data class AssistantResponseFormat(val type: String, val jsonSchema: AssistantResponseFormat.JsonSchema? = null)

Represents the format of the response from the assistant.

AssistantTool

@Serializable

sealed interface AssistantTool

A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

CodeInterpreterResources

@Serializable

data class CodeInterpreterResources(val fileIds: List<FileId>? = null)

FileSearchResources

@Serializable

data class FileSearchResources(val vectorStoreIds: List<VectorStoreId>? = null)

Function

@Serializable