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

use crate::{
    config::Config,
    error::OpenAIError,
    types::responses::{
        ConversationItem, ConversationItemList, ConversationResource,
        CreateConversationItemsRequest,
    },
    Client, RequestOptions,
};

/// Conversation items represent items within a conversation.
pub struct ConversationItems<'c, C: Config> {
    client: &'c Client<C>,
    pub conversation_id: String,
    pub(crate) request_options: RequestOptions,
}

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

    /// Create items in a conversation.
    #[crate::byot(T0 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn create(
        &self,
        request: CreateConversationItemsRequest,
    ) -> Result<ConversationItemList, OpenAIError> {
        self.client
            .post(
                &format!("/conversations/{}/items", &self.conversation_id),
                request,
                &self.request_options,
            )
            .await
    }

    /// List all items for a conversation.
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list(&self) -> Result<ConversationItemList, OpenAIError> {
        self.client
            .get(
                &format!("/conversations/{}/items", &self.conversation_id),
                &self.request_options,
            )
            .await
    }

    /// Retrieve an item from a conversation.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn retrieve(&self, item_id: &str) -> Result<ConversationItem, OpenAIError> {
        self.client
            .get(
                &format!("/conversations/{}/items/{item_id}", &self.conversation_id),
                &self.request_options,
            )
            .await
    }

    /// Delete an item from a conversation.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn delete(&self, item_id: &str) -> Result<ConversationResource, OpenAIError> {
        self.client
            .delete(
                &format!("/conversations/{}/items/{item_id}", &self.conversation_id),
                &self.request_options,
            )
            .await
    }
}