oaapi 0.2.0

An unofficial Rust client for the OpenAI API.
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

use serde::{Deserialize, Serialize};

use crate::chat::Role;
use crate::macros::impl_display_for_serialize;
use crate::Prompt;

/// The system message.
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct SystemMessage {
    /// The contents of the system message.
    content: String,
    /// The role of the messages author, in this case system.
    role: Role,
    /// An optional name for the participant.
    /// Provides the model information to differentiate between participants of the same role.
    #[serde(skip_serializing_if = "Option::is_none")]
    name: Option<String>,
}

impl Default for SystemMessage {
    fn default() -> Self {
        Self {
            content: "".to_string(),
            role: Role::System,
            name: None,
        }
    }
}

impl_display_for_serialize!(SystemMessage);

impl SystemMessage {
    pub fn new<S>(
        content: S,
        name: Option<String>,
    ) -> Self
    where
        S: Into<String>,
    {
        Self {
            content: content.into(),
            role: Role::System,
            name,
        }
    }

    pub fn from_prompt(
        prompt: Prompt,
        name: Option<String>,
    ) -> Self {
        Self {
            content: prompt.format(),
            role: Role::System,
            name,
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn deserialize_system_message() {
        let json = r#"{
            "content": "Hello, world!",
            "role": "system",
            "name": "System"
        }"#;
        let message: SystemMessage = serde_json::from_str(json).unwrap();
        assert_eq!(
            message,
            SystemMessage::new(
                "Hello, world!".to_string(),
                Some("System".to_string()),
            ),
        );
    }

    #[test]
    fn deserialize_system_message_without_optional() {
        let json = r#"{
            "content": "Hello, world!",
            "role": "system"
        }"#;
        let message: SystemMessage = serde_json::from_str(json).unwrap();
        assert_eq!(
            message,
            SystemMessage::new("Hello, world!".to_string(), None,),
        );
    }

    #[test]
    fn serialize_system_message() {
        let message = SystemMessage::new(
            "Hello, world!".to_string(),
            Some("System".to_string()),
        );
        let json = serde_json::to_string(&message).unwrap();
        assert_eq!(
            json,
            r#"{"content":"Hello, world!","role":"system","name":"System"}"#,
        );
    }

    #[test]
    fn serialize_system_message_without_optional() {
        let message = SystemMessage::new("Hello, world!".to_string(), None);
        let json = serde_json::to_string(&message).unwrap();
        assert_eq!(
            json,
            r#"{"content":"Hello, world!","role":"system"}"#,
        );
    }
}