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

Package-level declarations

Types

Attachment

@Serializable

data class Attachment(val fileId: FileId? = null, val tools: List<AssistantTool>? = null)

References an Attachment in the message request.

AttachmentBuilder

class AttachmentBuilder

A message attachment builder.

FileCitation

@Serializable

data class FileCitation(val fileId: FileId, val quote: String? = null)

FileCitationAnnotation

@Serializable

@SerialName(value = "file_citation")

data class FileCitationAnnotation(val text: String, val startIndex: Int, val endIndex: Int, val fileCitation: FileCitation) : TextAnnotation

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "retrieval" tool to search files.

FilePath

@Serializable

data class FilePath(val path: FileId)

FilePathAnnotation

@Serializable

@SerialName(value = "file_path")

data class FilePathAnnotation(val text: String, val startIndex: Int, val endIndex: Int, val filePath: FilePath) : TextAnnotation

A URL for the file that's generated when the assistant used the code interpreter tool to generate a file.

ImageFile

@Serializable

data class ImageFile(val fileId: FileId)

References an image File in the content of a message.

Message

@Serializable

data class Message(val id: MessageId, val createdAt: Int, val threadId: ThreadId, val role: Role, val content: List<MessageContent>, val assistantId: AssistantId? = null, val runId: RunId? = null, val metadata: Map<String, String>)

Represents a message within a thread.

MessageContent

@Serializable

sealed interface MessageContent

The content of the message as text or image.

MessageId

@Serializable

@JvmInline

value class MessageId(val id: String)

A message id.

MessageRequest

@Serializable