openai-client-base 0.12.0

Auto-generated Rust client for the OpenAI API
/*
 * OpenAI API
 *
 * The OpenAI REST API. Please see https://platform.openai.com/docs/api-reference for more details.
 *
 * The version of the OpenAPI document: 2.3.0
 *
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

/// MessageObject : Represents a message within a [thread](/docs/api-reference/threads).
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct MessageObject {
    /// The identifier, which can be referenced in API endpoints.
    #[serde(rename = "id")]
    pub id: String,
    /// The object type, which is always `thread.message`.
    #[serde(rename = "object")]
    pub object: Object,
    /// The Unix timestamp (in seconds) for when the message was created.
    #[serde(rename = "created_at")]
    pub created_at: i32,
    /// The [thread](/docs/api-reference/threads) ID that this message belongs to.
    #[serde(rename = "thread_id")]
    pub thread_id: String,
    /// The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.
    #[serde(rename = "status")]
    pub status: Status,
    #[serde(
        rename = "incomplete_details",
        deserialize_with = "Option::deserialize"
    )]
    pub incomplete_details: Option<Box<models::Object09>>,
    /// The Unix timestamp (in seconds) for when the message was completed.
    #[serde(rename = "completed_at", deserialize_with = "Option::deserialize")]
    pub completed_at: Option<i32>,
    /// The Unix timestamp (in seconds) for when the message was marked as incomplete.
    #[serde(rename = "incomplete_at", deserialize_with = "Option::deserialize")]
    pub incomplete_at: Option<i32>,
    /// The entity that produced the message. One of `user` or `assistant`.
    #[serde(rename = "role")]
    pub role: Role,
    /// The content of the message in array of text and/or images.
    #[serde(rename = "content")]
    pub content: Vec<models::MessageObjectContentInner>,
    /// If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message.
    #[serde(rename = "assistant_id", deserialize_with = "Option::deserialize")]
    pub assistant_id: Option<String>,
    /// The ID of the [run](/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints.
    #[serde(rename = "run_id", deserialize_with = "Option::deserialize")]
    pub run_id: Option<String>,
    /// A list of files attached to the message, and the tools they were added to.
    #[serde(rename = "attachments", deserialize_with = "Option::deserialize")]
    pub attachments: Option<Vec<models::CreateMessageRequestAttachmentsInner>>,
    /// 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, and querying for objects via API or the dashboard.  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
    #[serde(rename = "metadata", deserialize_with = "Option::deserialize")]
    pub metadata: Option<std::collections::HashMap<String, String>>,
}

impl MessageObject {
    /// Represents a message within a [thread](/docs/api-reference/threads).
    pub fn new(
        id: String,
        object: Object,
        created_at: i32,
        thread_id: String,
        status: Status,
        incomplete_details: Option<models::Object09>,
        completed_at: Option<i32>,
        incomplete_at: Option<i32>,
        role: Role,
        content: Vec<models::MessageObjectContentInner>,
        assistant_id: Option<String>,
        run_id: Option<String>,
        attachments: Option<Vec<models::CreateMessageRequestAttachmentsInner>>,
        metadata: Option<std::collections::HashMap<String, String>>,
    ) -> MessageObject {
        MessageObject {
            id,
            object,
            created_at,
            thread_id,
            status,
            incomplete_details: incomplete_details.map(Box::new),
            completed_at,
            incomplete_at,
            role,
            content,
            assistant_id,
            run_id,
            attachments,
            metadata,
        }
    }
}
/// The object type, which is always `thread.message`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Object {
    #[serde(rename = "thread.message")]
    ThreadMessage,
}

impl Default for Object {
    fn default() -> Object {
        Self::ThreadMessage
    }
}
/// The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Status {
    #[serde(rename = "in_progress")]
    InProgress,
    #[serde(rename = "incomplete")]
    Incomplete,
    #[serde(rename = "completed")]
    Completed,
}

impl Default for Status {
    fn default() -> Status {
        Self::InProgress
    }
}
/// The entity that produced the message. One of `user` or `assistant`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Role {
    #[serde(rename = "user")]
    User,
    #[serde(rename = "assistant")]
    Assistant,
}

impl Default for Role {
    fn default() -> Role {
        Self::User
    }
}

impl std::fmt::Display for MessageObject {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match serde_json::to_string(self) {
            Ok(s) => write!(f, "{}", s),
            Err(_) => Err(std::fmt::Error),
        }
    }
}