outfox-openai 0.7.0

Openai for outfox
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259

use serde::Deserialize;

/// Response structure for organization usage endpoints.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageResponse {
    /// The object type, which is always `page`.
    pub object: String,
    /// List of time buckets containing usage data.
    pub data: Vec<UsageTimeBucket>,
    /// Whether there are more pages available.
    pub has_more: bool,
    /// Cursor for the next page.
    pub next_page: Option<String>,
}

/// A time bucket containing usage results.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageTimeBucket {
    /// The object type, which is always `bucket`.
    pub object: String,
    /// Start time of the bucket (Unix seconds).
    pub start_time: u64,
    /// End time of the bucket (Unix seconds).
    pub end_time: u64,
    /// Start time of the bucket in ISO 8601 format.
    #[serde(default)]
    pub start_time_iso: Option<String>,
    /// End time of the bucket in ISO 8601 format.
    #[serde(default)]
    pub end_time_iso: Option<String>,
    /// Usage results for this time bucket.
    pub results: Vec<UsageResult>,
}

/// Discriminated union of all possible usage result types.
#[derive(Debug, Clone, Deserialize)]
#[serde(untagged)]
pub enum UsageResult {
    AudioSpeeches(UsageAudioSpeechesResult),
    AudioTranscriptions(UsageAudioTranscriptionsResult),
    CodeInterpreterSessions(UsageCodeInterpreterSessionsResult),
    Completions(UsageCompletionsResult),
    Embeddings(UsageEmbeddingsResult),
    Images(UsageImagesResult),
    Moderations(UsageModerationsResult),
    VectorStores(UsageVectorStoresResult),
    Costs(CostsResult),
}

/// The aggregated audio speeches usage details of the specific time bucket.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageAudioSpeechesResult {
    /// The object type, which is always `organization.usage.audio_speeches.result`.
    pub object: String,
    /// The number of characters processed.
    pub characters: u64,
    /// The count of requests made to the model.
    pub num_model_requests: u64,
    /// When `group_by=project_id`, this field provides the project ID of the grouped usage result.
    pub project_id: Option<String>,
    /// When `group_by=user_id`, this field provides the user ID of the grouped usage result.
    pub user_id: Option<String>,
    /// When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
    pub api_key_id: Option<String>,
    /// When `group_by=model`, this field provides the model name of the grouped usage result.
    pub model: Option<String>,
}

/// The aggregated audio transcriptions usage details of the specific time bucket.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageAudioTranscriptionsResult {
    /// The object type, which is always `organization.usage.audio_transcriptions.result`.
    pub object: String,
    /// The number of seconds processed.
    pub seconds: u64,
    /// The count of requests made to the model.
    pub num_model_requests: u64,
    /// When `group_by=project_id`, this field provides the project ID of the grouped usage result.
    pub project_id: Option<String>,
    /// When `group_by=user_id`, this field provides the user ID of the grouped usage result.
    pub user_id: Option<String>,
    /// When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
    pub api_key_id: Option<String>,
    /// When `group_by=model`, this field provides the model name of the grouped usage result.
    pub model: Option<String>,
}

/// The aggregated code interpreter sessions usage details of the specific time bucket.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageCodeInterpreterSessionsResult {
    /// The object type, which is always `organization.usage.code_interpreter_sessions.result`.
    pub object: String,
    /// The number of code interpreter sessions.
    pub num_sessions: u64,
    /// When `group_by=project_id`, this field provides the project ID of the grouped usage result.
    pub project_id: Option<String>,
    /// When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
    pub api_key_id: Option<String>,
}

/// The aggregated completions usage details of the specific time bucket.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageCompletionsResult {
    /// The object type, which is always `organization.usage.completions.result`.
    pub object: String,
    /// The aggregated number of text input tokens used, including cached tokens. For customers
    /// subscribe to scale tier, this includes scale tier tokens.
    pub input_tokens: u64,
    /// The aggregated number of text output tokens used. For customers subscribe to scale tier,
    /// this includes scale tier tokens.
    pub output_tokens: u64,
    /// The aggregated number of text input tokens that has been cached from previous requests. For
    /// customers subscribe to scale tier, this includes scale tier tokens.
    #[serde(default)]
    pub input_cached_tokens: Option<u64>,
    /// The aggregated number of uncached input tokens.
    #[serde(default)]
    pub input_uncached_tokens: Option<u64>,
    /// The aggregated number of text input tokens used.
    #[serde(default)]
    pub input_text_tokens: Option<u64>,
    /// The aggregated number of text output tokens used.
    #[serde(default)]
    pub output_text_tokens: Option<u64>,
    /// The aggregated number of cached text input tokens.
    #[serde(default)]
    pub input_cached_text_tokens: Option<u64>,
    /// The aggregated number of audio input tokens used, including cached tokens.
    #[serde(default)]
    pub input_audio_tokens: Option<u64>,
    /// The aggregated number of cached audio input tokens.
    #[serde(default)]
    pub input_cached_audio_tokens: Option<u64>,
    /// The aggregated number of audio output tokens used.
    #[serde(default)]
    pub output_audio_tokens: Option<u64>,
    /// The aggregated number of image input tokens used.
    #[serde(default)]
    pub input_image_tokens: Option<u64>,
    /// The aggregated number of cached image input tokens.
    #[serde(default)]
    pub input_cached_image_tokens: Option<u64>,
    /// The aggregated number of image output tokens used.
    #[serde(default)]
    pub output_image_tokens: Option<u64>,
    /// The count of requests made to the model.
    pub num_model_requests: u64,
    /// When `group_by=project_id`, this field provides the project ID of the grouped usage result.
    pub project_id: Option<String>,
    /// When `group_by=user_id`, this field provides the user ID of the grouped usage result.
    pub user_id: Option<String>,
    /// When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
    pub api_key_id: Option<String>,
    /// When `group_by=model`, this field provides the model name of the grouped usage result.
    pub model: Option<String>,
    /// When `group_by=batch`, this field tells whether the grouped usage result is batch or not.
    pub batch: Option<bool>,
    /// When `group_by=service_tier`, this field provides the service tier of the grouped usage
    /// result.
    pub service_tier: Option<String>,
}

/// The aggregated embeddings usage details of the specific time bucket.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageEmbeddingsResult {
    /// The object type, which is always `organization.usage.embeddings.result`.
    pub object: String,
    /// The aggregated number of input tokens used.
    pub input_tokens: u64,
    /// The count of requests made to the model.
    pub num_model_requests: u64,
    /// When `group_by=project_id`, this field provides the project ID of the grouped usage result.
    pub project_id: Option<String>,
    /// When `group_by=user_id`, this field provides the user ID of the grouped usage result.
    pub user_id: Option<String>,
    /// When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
    pub api_key_id: Option<String>,
    /// When `group_by=model`, this field provides the model name of the grouped usage result.
    pub model: Option<String>,
}

/// The aggregated images usage details of the specific time bucket.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageImagesResult {
    /// The object type, which is always `organization.usage.images.result`.
    pub object: String,
    /// The number of images processed.
    pub images: u64,
    /// The count of requests made to the model.
    pub num_model_requests: u64,
    /// When `group_by=source`, this field provides the source of the grouped usage result,
    /// possible values are `image.generation`, `image.edit`, `image.variation`.
    pub source: Option<String>,
    /// When `group_by=size`, this field provides the image size of the grouped usage result.
    pub size: Option<String>,
    /// When `group_by=project_id`, this field provides the project ID of the grouped usage result.
    pub project_id: Option<String>,
    /// When `group_by=user_id`, this field provides the user ID of the grouped usage result.
    pub user_id: Option<String>,
    /// When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
    pub api_key_id: Option<String>,
    /// When `group_by=model`, this field provides the model name of the grouped usage result.
    pub model: Option<String>,
}

/// The aggregated moderations usage details of the specific time bucket.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageModerationsResult {
    /// The object type, which is always `organization.usage.moderations.result`.
    pub object: String,
    /// The aggregated number of input tokens used.
    pub input_tokens: u64,
    /// The count of requests made to the model.
    pub num_model_requests: u64,
    /// When `group_by=project_id`, this field provides the project ID of the grouped usage result.
    pub project_id: Option<String>,
    /// When `group_by=user_id`, this field provides the user ID of the grouped usage result.
    pub user_id: Option<String>,
    /// When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
    pub api_key_id: Option<String>,
    /// When `group_by=model`, this field provides the model name of the grouped usage result.
    pub model: Option<String>,
}

/// The aggregated vector stores usage details of the specific time bucket.
#[derive(Debug, Clone, Deserialize)]
pub struct UsageVectorStoresResult {
    /// The object type, which is always `organization.usage.vector_stores.result`.
    pub object: String,
    /// The vector stores usage in bytes.
    pub usage_bytes: u64,
    /// When `group_by=project_id`, this field provides the project ID of the grouped usage result.
    pub project_id: Option<String>,
}

/// The aggregated costs details of the specific time bucket.
#[derive(Debug, Clone, Deserialize)]
pub struct CostsResult {
    /// The object type, which is always `organization.costs.result`.
    pub object: String,
    /// The monetary value in its associated currency.
    pub amount: CostsAmount,
    /// When `group_by=line_item`, this field provides the line item of the grouped costs result.
    pub line_item: Option<String>,
    /// When `group_by=project_id`, this field provides the project ID of the grouped costs result.
    pub project_id: Option<String>,
    /// The organization ID.
    #[serde(default)]
    pub organization_id: Option<String>,
}

/// The monetary value in its associated currency.
#[derive(Debug, Clone, Deserialize)]
pub struct CostsAmount {
    /// The numeric value of the cost.
    pub value: f64,
    /// Lowercase ISO-4217 currency e.g. "usd"
    pub currency: String,
}