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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use crate::{
    config::Config,
    error::OpenAIError,
    types::chatkit::{
        ChatSessionResource, CreateChatSessionBody, DeletedThreadResource, ThreadItemListResource,
        ThreadListResource, ThreadResource,
    },
    Client, RequestOptions,
};

/// ChatKit API for managing sessions and threads.
///
/// Related guide: [ChatKit](https://platform.openai.com/docs/api-reference/chatkit)
pub struct Chatkit<'c, C: Config> {
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> Chatkit<'c, C> {
    pub fn new(client: &'c Client<C>) -> Self {
        Self {
            client,
            request_options: RequestOptions::new(),
        }
    }

    /// Access sessions API.
    pub fn sessions(&self) -> ChatkitSessions<'_, C> {
        ChatkitSessions::new(self.client)
    }

    /// Access threads API.
    pub fn threads(&self) -> ChatkitThreads<'_, C> {
        ChatkitThreads::new(self.client)
    }
}

/// ChatKit sessions API.
pub struct ChatkitSessions<'c, C: Config> {
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> ChatkitSessions<'c, C> {
    pub fn new(client: &'c Client<C>) -> Self {
        Self {
            client,
            request_options: RequestOptions::new(),
        }
    }

    /// Create a ChatKit session.
    #[crate::byot(T0 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn create(
        &self,
        request: CreateChatSessionBody,
    ) -> Result<ChatSessionResource, OpenAIError> {
        self.client
            .post("/chatkit/sessions", request, &self.request_options)
            .await
    }

    /// Cancel a ChatKit session.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn cancel(&self, session_id: &str) -> Result<ChatSessionResource, OpenAIError> {
        self.client
            .post(
                &format!("/chatkit/sessions/{session_id}/cancel"),
                serde_json::json!({}),
                &self.request_options,
            )
            .await
    }
}

/// ChatKit threads API.
pub struct ChatkitThreads<'c, C: Config> {
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> ChatkitThreads<'c, C> {
    pub fn new(client: &'c Client<C>) -> Self {
        Self {
            client,
            request_options: RequestOptions::new(),
        }
    }

    /// List ChatKit threads.
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list(&self) -> Result<ThreadListResource, OpenAIError> {
        self.client
            .get("/chatkit/threads", &self.request_options)
            .await
    }

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

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

    /// List ChatKit thread items.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn list_items(&self, thread_id: &str) -> Result<ThreadItemListResource, OpenAIError> {
        self.client
            .get(
                &format!("/chatkit/threads/{thread_id}/items"),
                &self.request_options,
            )
            .await
    }
}