async-openai 0.34.0

Rust library for OpenAI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

use crate::{
    config::Config,
    error::OpenAIError,
    types::assistants::{
        CreateMessageRequest, DeleteMessageResponse, ListMessagesResponse, MessageObject,
        ModifyMessageRequest,
    },
    Client, RequestOptions,
};

/// Represents a message within a [thread](https://platform.openai.com/docs/api-reference/threads).
#[deprecated(
    note = "Assistants API is deprecated and will be removed in August 2026. Use the Responses API."
)]
pub struct Messages<'c, C: Config> {
    ///  The ID of the [thread](https://platform.openai.com/docs/api-reference/threads) to create a message for.
    pub thread_id: String,
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> Messages<'c, C> {
    pub fn new(client: &'c Client<C>, thread_id: &str) -> Self {
        Self {
            client,
            thread_id: thread_id.into(),
            request_options: RequestOptions::new(),
        }
    }

    /// Create a message.
    #[crate::byot(T0 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn create(
        &self,
        request: CreateMessageRequest,
    ) -> Result<MessageObject, OpenAIError> {
        self.client
            .post(
                &format!("/threads/{}/messages", self.thread_id),
                request,
                &self.request_options,
            )
            .await
    }

    /// Retrieve a message.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn retrieve(&self, message_id: &str) -> Result<MessageObject, OpenAIError> {
        self.client
            .get(
                &format!("/threads/{}/messages/{message_id}", self.thread_id),
                &self.request_options,
            )
            .await
    }

    /// Modifies a message.
    #[crate::byot(T0 = std::fmt::Display, T1 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn update(
        &self,
        message_id: &str,
        request: ModifyMessageRequest,
    ) -> Result<MessageObject, OpenAIError> {
        self.client
            .post(
                &format!("/threads/{}/messages/{message_id}", self.thread_id),
                request,
                &self.request_options,
            )
            .await
    }

    /// Returns a list of messages for a given thread.
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list(&self) -> Result<ListMessagesResponse, OpenAIError> {
        self.client
            .get(
                &format!("/threads/{}/messages", self.thread_id),
                &self.request_options,
            )
            .await
    }

    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn delete(&self, message_id: &str) -> Result<DeleteMessageResponse, OpenAIError> {
        self.client
            .delete(
                &format!("/threads/{}/messages/{message_id}", self.thread_id),
                &self.request_options,
            )
            .await
    }
}