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

MessageRequest

@Serializable

class MessageRequest(val role: Role, val content: String, val fileIds: List<FileId>? = null, val metadata: Map<String, String>? = null)

Create a message request.

Constructors

MessageRequest

constructor(role: Role, content: String, fileIds: List<FileId>? = null, metadata: Map<String, String>? = null)

Properties

content

val content: String

The content of the message.

fileIds

val fileIds: List<FileId>? = null

A list of File IDs that the message should use. There can be a maximum of 10 files attached to a message. Useful for tools like retrieval and code interpreter that can access and use files.

metadata

val metadata: Map<String, String>? = null

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.

role

val role: Role

The role of the entity that is creating the message. Currently only Role.User is supported.