openairs 0.1.1

A simple and efficient wrapper around 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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177



use serde::{Deserialize, Serialize};

use crate::client::{OpenAIRequest, OpenAIResponse};

#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct CreateImageRequest {
    pub prompt: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub n: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub size: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub response_format: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

const CREATE_IMAGE_ENDPOINT: &str = "https://api.openai.com/v1/images/generations";

impl OpenAIRequest for CreateImageRequest {
    fn endpoint(&self) -> &str {
        CREATE_IMAGE_ENDPOINT
    }
}

impl CreateImageRequest {
    pub fn new(prompt: &str) -> Self {
        CreateImageRequest {
            prompt: prompt.to_owned(),
            ..Default::default()
        }
    }

    pub fn n(mut self, n: i32) -> Self {
        self.n = Some(n);
        self
    }

    pub fn size(mut self, size: String) -> Self {
        self.size = Some(size);
        self
    }

    pub fn response_format(mut self, response_format: String) -> Self {
        self.response_format = Some(response_format);
        self
    }

    pub fn user(mut self, user: String) -> Self {
        self.user = Some(user);
        self
    }
}

#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct ImageResponse {
    pub created: usize,
    pub data: Vec<ImageUrl>,
}

#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct ImageUrl {
    pub url: String,
}

impl OpenAIResponse for ImageResponse {}

#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct ImageEditRequest {
    pub image: String,
    pub prompt: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mask: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub n: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub size: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub response_format: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

const IMAGE_EDIT_ENDPOINT: &str = "https://api.openai.com/v1/images/edits";

impl OpenAIRequest for ImageEditRequest {
    fn endpoint(&self) -> &str {
        IMAGE_EDIT_ENDPOINT
    }
}

impl ImageEditRequest {
    pub fn new(image: &str, prompt: &str) -> Self {
        ImageEditRequest {
            image: image.to_owned(),
            prompt: prompt.to_owned(),
            ..Default::default()
        }
    }

    pub fn n(mut self, n: i32) -> Self {
        self.n = Some(n);
        self
    }

    pub fn size(mut self, size: String) -> Self {
        self.size = Some(size);
        self
    }

    pub fn mask(mut self, mask: String) -> Self {
        self.mask = Some(mask);
        self
    }

    pub fn response_format(mut self, response_format: String) -> Self {
        self.response_format = Some(response_format);
        self
    }

    pub fn user(mut self, user: String) -> Self {
        self.user = Some(user);
        self
    }
}

#[derive(Serialize, Deserialize, Debug, Clone, Default)]
pub struct ImageVariationRequest {
    pub image: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub n: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub size: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub response_format: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

const IMAGE_VARIATION_ENDPOINT: &str = "https://api.openai.com/v1/images/variations";

impl OpenAIRequest for ImageVariationRequest {
    fn endpoint(&self) -> &str {
        IMAGE_VARIATION_ENDPOINT
    }
}

impl ImageVariationRequest {
    pub fn new(image: &str) -> Self {
        ImageVariationRequest {
            image: image.to_owned(),
            ..Default::default()
        }
    }

    pub fn n(mut self, n: i32) -> Self {
        self.n = Some(n);
        self
    }

    pub fn size(mut self, size: String) -> Self {
        self.size = Some(size);
        self
    }

    pub fn response_format(mut self, response_format: String) -> Self {
        self.response_format = Some(response_format);
        self
    }

    pub fn user(mut self, user: String) -> Self {
        self.user = Some(user);
        self
    }
}