Struct MessageObject

pub struct MessageObject {

    pub id: String,
    pub created_at: u64,
    pub thread_id: String,
    pub status: MessageObjectStatus,
    pub incomplete_details: Option<MessageObjectIncompleteDetails>,
    pub completed_at: Option<u64>,
    pub incomplete_at: Option<u64>,
    pub role: MessageObjectRole,
    pub content: Vec<MessageContent>,
    pub assistant_id: Option<String>,
    pub run_id: Option<String>,
    pub attachments: Option<Vec<MessageObjectAttachments>>,
    pub metadata: Option<Metadata>,
}

Represents a message within a thread.

Fields

id: String

The identifier, which can be referenced in API endpoints.

created_at: u64

The Unix timestamp (in seconds) for when the message was created.

thread_id: String

The thread ID that this message belongs to.

status: MessageObjectStatus

The status of the message, which can be either in_progress, incomplete, or completed.

incomplete_details: Option<MessageObjectIncompleteDetails>

On an incomplete message, details about why the message is incomplete.

completed_at: Option<u64>

The Unix timestamp (in seconds) for when the message was completed.

incomplete_at: Option<u64>

The Unix timestamp (in seconds) for when the message was marked as incomplete.

role: MessageObjectRole

The entity that produced the message. One of user or assistant.

content: Vec<MessageContent>

The content of the message in array of text and/or images.

assistant_id: Option<String>

If applicable, the ID of the assistant that authored this message.

run_id: Option<String>

The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.

attachments: Option<Vec<MessageObjectAttachments>>

A list of files attached to the message, and the tools they were added to.

metadata: Option<Metadata>

Implementations

impl MessageObject

pub fn builder() -> MessageObjectBuilder<((), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building MessageObject. On the builder, call .id(...), .created_at(...), .thread_id(...), .status(...), .incomplete_details(...)(optional), .completed_at(...)(optional), .incomplete_at(...)(optional), .role(...), .content(...), .assistant_id(...)(optional), .run_id(...)(optional), .attachments(...)(optional), .metadata(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of MessageObject.

Trait Implementations

impl Clone for MessageObject

fn clone(&self) -> MessageObject

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MessageObject

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageObject

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MessageObject

fn eq(&self, other: &MessageObject) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MessageObject

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MessageObject