Package-level declarations

Types

Link copied to clipboard
data class CreateThreadMessageRequest(var role: ThreadUser, var content: String, var fileIds: MutableList<String>?, var metadata: MutableMap<String, String>?)

Represents a request to create a new message in a Thread.

Link copied to clipboard
Link copied to clipboard
data class ListMessageFilesRequest(var limit: Int? = null, var order: ListOrder? = null, var after: String? = null, var before: String? = null)

Represents a request to list all MessageFiles in a ThreadMessage.

Link copied to clipboard
data class ListMessageFilesResponse(val data: List<MessageFile>, val firstId: String?, val lastId: String?, val hasMore: Boolean)

A data class which represents a response from the OpenAI API containing a list of MessageFiles.

Link copied to clipboard
data class ListThreadMessagesRequest(var limit: Int? = null, var order: ListOrder? = null, var after: String? = null, var before: String? = null)

Represents a request to list ThreadMessages in a Thread. If a thread has too many messages, you may need to use the after or before parameters to page through them via multiple requests.

Link copied to clipboard
data class ListThreadMessagesResponse(val data: List<ThreadMessage>, val firstId: String?, val lastId: String?, val hasMore: Boolean)

A data class which represents a response from the OpenAI API containing a list of ThreadMessages.

Link copied to clipboard
data class MessageFile(val id: String, val createdAt: Int, val messageId: String)

Represents a file attached to a ThreadMessage.

Link copied to clipboard

Handler used to interact with a MessageFile objects.

Link copied to clipboard
class MessageFileHandlerImpl(requestHelper: RequestHelper, endpoint: String, val threadId: String, val messageId: String) : MessageFileHandler
Link copied to clipboard
interface MessageHandler

Handler used to interact with a ThreadMessage objects.

Link copied to clipboard
class MessageHandlerImpl(requestHelper: RequestHelper, endpoint: String, val threadId: String) : MessageHandler
Link copied to clipboard

Represents a request to modify a ThreadMessage.

Link copied to clipboard
sealed class TextAnnotation

A TextContent created by an Assistant may contain annotations.

Link copied to clipboard

Represents the text output of a message.

Link copied to clipboard
data class ThreadMessage(val id: String, val createdAt: Int, val threadId: String, val role: ThreadUser, val content: List<ThreadMessageContent>, val assistantId: String?, val runId: String?, val fileIds: List<String>, val metadata: Map<String, String>)

Represents a message in a Thread.

Link copied to clipboard

A sealed class which represents a message in a thread.

Link copied to clipboard

Represents a user that sends messages in a Thread.