openai-oxide 0.15.0

Idiomatic Rust client for the OpenAI API — 1:1 parity with the official Python SDK
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
//! OpenAPI spec coverage tests.
//!
//! Parses tests/openapi.yaml, extracts schema fields,
//! compares with our Rust types to ensure coverage.
//! For request types (Serialize): serialize default and check fields.
//! For response types (Deserialize): build fixture with ALL spec fields, verify deserialization.

use std::collections::{HashMap, HashSet};

/// Parse OpenAPI YAML and extract schema field names.
fn load_openapi_schemas() -> HashMap<String, Vec<String>> {
    let yaml_str =
        std::fs::read_to_string("tests/openapi.yaml").expect("tests/openapi.yaml not found");
    // Strip lines with huge integers that overflow serde_yaml i64
    let yaml_str: String = yaml_str
        .lines()
        .filter(|line| !line.contains("9223372036854") && !line.contains("922337203685477"))
        .collect::<Vec<_>>()
        .join("\n");
    let doc: serde_yaml::Value = serde_yaml::from_str(&yaml_str).expect("Invalid YAML");

    let schemas = doc
        .get("components")
        .and_then(|c| c.get("schemas"))
        .expect("No components.schemas in OpenAPI spec");

    let mut result = HashMap::new();

    if let serde_yaml::Value::Mapping(map) = schemas {
        for (key, value) in map {
            let name = key.as_str().unwrap_or("").to_string();
            let mut fields = Vec::new();

            if let Some(props) = value.get("properties") {
                if let serde_yaml::Value::Mapping(props_map) = props {
                    for (field_key, _) in props_map {
                        if let Some(field_name) = field_key.as_str() {
                            fields.push(field_name.to_string());
                        }
                    }
                }
            }

            if let Some(all_of) = value.get("allOf") {
                if let serde_yaml::Value::Sequence(items) = all_of {
                    for item in items {
                        if let Some(props) = item.get("properties") {
                            if let serde_yaml::Value::Mapping(props_map) = props {
                                for (field_key, _) in props_map {
                                    if let Some(field_name) = field_key.as_str() {
                                        fields.push(field_name.to_string());
                                    }
                                }
                            }
                        }
                    }
                }
            }

            if !fields.is_empty() {
                result.insert(name, fields);
            }
        }
    }

    result
}

/// Extract ALL field names from a Serialize type (including None fields).
/// Uses a custom serializer that captures field names regardless of skip_serializing_if.

/// Extract field names by grepping the Rust source file for `pub fieldname:`.
fn fields_from_source(source_path: &str, struct_name: &str) -> HashSet<String> {
    let content = std::fs::read_to_string(source_path).unwrap_or_default();
    let mut fields = HashSet::new();
    let mut in_struct = false;
    let mut brace_depth = 0;

    for line in content.lines() {
        let trimmed = line.trim();

        if trimmed.contains(&format!("pub struct {struct_name}")) {
            in_struct = true;
            if trimmed.contains('{') {
                brace_depth = 1;
            }
            continue;
        }

        if in_struct {
            brace_depth += trimmed.matches('{').count();
            brace_depth = brace_depth.saturating_sub(trimmed.matches('}').count());

            if brace_depth == 0 {
                break;
            }

            // Match: pub field_name: Type
            if let Some(field) = trimmed.strip_prefix("pub ") {
                if let Some(name) = field.split(':').next() {
                    let name = name.trim();
                    if !name.is_empty() && !name.contains('(') && !name.contains('<') {
                        // Check for serde rename
                        let rename = content[..content.find(&format!("pub {name}:")).unwrap_or(0)]
                            .lines()
                            .rev()
                            .take(3)
                            .find(|l| l.contains("serde(rename"))
                            .and_then(|l| l.split('"').nth(1).map(|s| s.to_string()));
                        fields.insert(rename.unwrap_or_else(|| name.to_string()));
                    }
                }
            }
        }
    }

    fields
}

/// Check coverage and print report.
fn check_coverage(schema_name: &str, spec_fields: &[String], rust_fields: &HashSet<String>) -> f64 {
    if spec_fields.is_empty() {
        return 100.0;
    }
    let matched: Vec<_> = spec_fields
        .iter()
        .filter(|f| rust_fields.contains(f.as_str()))
        .collect();
    let pct = (matched.len() as f64 / spec_fields.len() as f64) * 100.0;

    let missing: Vec<_> = spec_fields
        .iter()
        .filter(|f| !rust_fields.contains(f.as_str()))
        .collect();

    eprintln!(
        "[{schema_name}] {:.0}% ({}/{}) {}",
        pct,
        matched.len(),
        spec_fields.len(),
        if missing.is_empty() {
            String::new()
        } else {
            format!("missing: {:?}", missing)
        }
    );

    pct
}

// ── Tests ──

#[test]
fn openapi_spec_loads() {
    let schemas = load_openapi_schemas();
    let expected = [
        "CreateChatCompletionRequest",
        "CreateChatCompletionResponse",
        "CreateEmbeddingRequest",
        "CreateImageRequest",
        "CreateModerationRequest",
    ];
    for name in &expected {
        assert!(
            schemas.contains_key(*name),
            "OpenAPI spec missing schema: {name}"
        );
    }
    eprintln!("OpenAPI spec loaded: {} schemas total", schemas.len());
}

#[test]
fn chat_completion_request_coverage() {
    let schemas = load_openapi_schemas();
    let spec = schemas
        .get("CreateChatCompletionRequest")
        .expect("schema not found");

    let rust_fields =
        fields_from_source("openai-types/src/chat/manual.rs", "ChatCompletionRequest");
    eprintln!("  Rust fields found: {:?}", rust_fields);

    let pct = check_coverage("CreateChatCompletionRequest", spec, &rust_fields);
    assert!(pct >= 60.0, "coverage {pct:.0}% < 60%");
}

#[test]
fn chat_completion_response_deserializes_all_spec_fields() {
    // Build a response JSON with ALL fields from the spec.
    // If our type can deserialize it, the fields are handled (even if as Option<Value>).
    let fixture = serde_json::json!({
        "id": "chatcmpl-abc123",
        "object": "chat.completion",
        "created": 1700000000_i64,
        "model": "gpt-4o",
        "choices": [{
            "index": 0,
            "message": {
                "role": "assistant",
                "content": "Hello world",
                "refusal": null,
                "tool_calls": null
            },
            "finish_reason": "stop",
            "logprobs": null
        }],
        "usage": {
            "prompt_tokens": 10,
            "completion_tokens": 5,
            "total_tokens": 15,
            "prompt_tokens_details": { "cached_tokens": 0, "audio_tokens": 0 },
            "completion_tokens_details": { "reasoning_tokens": 0, "audio_tokens": 0 }
        },
        "system_fingerprint": "fp_abc123",
        "service_tier": "default"
    });

    // This must not panic — serde should handle unknown fields gracefully
    let result: Result<openai_oxide::types::chat::ChatCompletionResponse, _> =
        serde_json::from_value(fixture);
    assert!(
        result.is_ok(),
        "Failed to deserialize full response fixture: {:?}",
        result.err()
    );
}

#[test]
fn embedding_request_coverage() {
    let schemas = load_openapi_schemas();
    let spec = schemas
        .get("CreateEmbeddingRequest")
        .expect("schema not found");

    let rust_fields = fields_from_source(
        "openai-types/src/embedding/manual.rs",
        "EmbeddingCreateRequest",
    );

    let pct = check_coverage("CreateEmbeddingRequest", spec, &rust_fields);
    assert!(pct >= 80.0, "coverage {pct:.0}% < 80%");
}

#[test]
fn overall_coverage_report() {
    let schemas = load_openapi_schemas();

    let request_checks: Vec<(&str, HashSet<String>)> = vec![
        (
            "CreateChatCompletionRequest",
            fields_from_source("openai-types/src/chat/manual.rs", "ChatCompletionRequest"),
        ),
        (
            "CreateEmbeddingRequest",
            fields_from_source(
                "openai-types/src/embedding/manual.rs",
                "EmbeddingCreateRequest",
            ),
        ),
        (
            "CreateImageRequest",
            fields_from_source("openai-types/src/image/manual.rs", "ImageGenerateRequest"),
        ),
        (
            "CreateModerationRequest",
            fields_from_source("openai-types/src/moderation/manual.rs", "ModerationRequest"),
        ),
    ];

    eprintln!("\n=== OpenAPI Coverage Report ===");
    let mut total_spec = 0;
    let mut total_matched = 0;

    for (schema_name, rust_fields) in &request_checks {
        if let Some(spec_fields) = schemas.get(*schema_name) {
            let matched = spec_fields
                .iter()
                .filter(|f| rust_fields.contains(f.as_str()))
                .count();
            total_spec += spec_fields.len();
            total_matched += matched;
            check_coverage(schema_name, spec_fields, rust_fields);
        }
    }

    let overall = if total_spec == 0 {
        100.0
    } else {
        total_matched as f64 / total_spec as f64 * 100.0
    };
    eprintln!("=== Overall: {overall:.0}% ({total_matched}/{total_spec}) ===\n");
    assert!(overall >= 80.0, "Overall coverage {overall:.0}% < 80%");
}

#[test]
fn chat_completion_response_coverage() {
    let schemas = load_openapi_schemas();
    let spec = schemas
        .get("CreateChatCompletionResponse")
        .expect("schema not found");

    let rust_fields =
        fields_from_source("openai-types/src/chat/manual.rs", "ChatCompletionResponse");
    let pct = check_coverage("CreateChatCompletionResponse", spec, &rust_fields);
    assert!(pct >= 80.0, "coverage {pct:.0}% < 80%");
}

#[test]
fn usage_details_deserialize() {
    let json = serde_json::json!({
        "prompt_tokens": 100,
        "completion_tokens": 50,
        "total_tokens": 150,
        "prompt_tokens_details": {
            "cached_tokens": 20,
            "audio_tokens": 5
        },
        "completion_tokens_details": {
            "reasoning_tokens": 10,
            "audio_tokens": 3,
            "accepted_prediction_tokens": 15,
            "rejected_prediction_tokens": 2
        }
    });

    let usage: openai_oxide::types::common::Usage = serde_json::from_value(json).unwrap();
    assert_eq!(usage.prompt_tokens, Some(100));
    let prompt_details = usage.prompt_tokens_details.unwrap();
    assert_eq!(prompt_details.cached_tokens, Some(20));
    assert_eq!(prompt_details.audio_tokens, Some(5));
    let completion_details = usage.completion_tokens_details.unwrap();
    assert_eq!(completion_details.reasoning_tokens, Some(10));
    assert_eq!(completion_details.accepted_prediction_tokens, Some(15));
    assert_eq!(completion_details.rejected_prediction_tokens, Some(2));
}

#[test]
fn chat_request_new_fields_serialize() {
    use openai_oxide::types::chat::*;

    let mut req = ChatCompletionRequest::new(
        "gpt-4o",
        vec![ChatCompletionMessageParam::User {
            content: UserContent::Text("Hi".into()),
            name: None,
        }],
    );
    req.reasoning_effort = Some(openai_oxide::types::common::ReasoningEffort::High);
    req.modalities = Some(vec!["text".into(), "audio".into()]);
    req.audio = Some(ChatCompletionAudioParam {
        format: "mp3".into(),
        voice: "alloy".into(),
    });
    req.prediction = Some(PredictionContent {
        type_: "content".into(),
        content: serde_json::json!("predicted text"),
    });
    req.web_search_options = Some(WebSearchOptions {
        search_context_size: Some(openai_oxide::types::common::SearchContextSize::Medium),
        user_location: None,
    });
    req.max_tokens = Some(1000);

    let json = serde_json::to_value(&req).unwrap();
    assert_eq!(json["reasoning_effort"], "high");
    assert_eq!(json["modalities"], serde_json::json!(["text", "audio"]));
    assert_eq!(json["audio"]["format"], "mp3");
    assert_eq!(json["audio"]["voice"], "alloy");
    assert_eq!(json["prediction"]["type"], "content");
    assert_eq!(json["web_search_options"]["search_context_size"], "medium");
    assert_eq!(json["max_tokens"], 1000);
}

// ── Phase 3: New coverage tests ──

#[test]
fn file_object_status_enum_deserialize() {
    use openai_oxide::types::file::{FilePurpose, FileStatus};
    let json = serde_json::json!({
        "id": "file-abc",
        "object": "file",
        "bytes": 100,
        "created_at": 1700000000_i64,
        "filename": "data.jsonl",
        "purpose": "fine-tune",
        "status": "processed"
    });
    let file: openai_oxide::types::file::FileObject = serde_json::from_value(json).unwrap();
    assert_eq!(file.purpose, FilePurpose::FineTune);
    assert_eq!(file.status, FileStatus::Processed);
}

#[test]
fn batch_status_enum_deserialize() {
    use openai_oxide::types::batch::BatchStatus;
    let json = serde_json::json!({
        "id": "batch_abc",
        "object": "batch",
        "endpoint": "/v1/chat/completions",
        "input_file_id": "file-abc",
        "completion_window": "24h",
        "status": "in_progress",
        "created_at": 1700000000_i64
    });
    let batch: openai_oxide::types::batch::Batch = serde_json::from_value(json).unwrap();
    assert_eq!(batch.status, BatchStatus::InProgress);
}

#[test]
fn upload_status_enum_deserialize() {
    use openai_oxide::types::upload::UploadStatus;
    let json = serde_json::json!({
        "id": "upload_abc",
        "object": "upload",
        "bytes": 2000000,
        "filename": "data.jsonl",
        "purpose": "fine-tune",
        "status": "completed",
        "created_at": 1700000000_i64
    });
    let upload: openai_oxide::types::upload::Upload = serde_json::from_value(json).unwrap();
    assert_eq!(upload.status, UploadStatus::Completed);
}

#[test]
fn fine_tuning_status_enum_deserialize() {
    use openai_oxide::types::fine_tuning::FineTuningStatus;
    let json = serde_json::json!({
        "id": "ftjob-abc",
        "object": "fine_tuning.job",
        "created_at": 1700000000_i64,
        "model": "gpt-4o-mini",
        "training_file": "file-abc",
        "status": "validating_files",
        "organization_id": "org-123",
        "result_files": [],
        "seed": 42
    });
    let job: openai_oxide::types::fine_tuning::FineTuningJob =
        serde_json::from_value(json).unwrap();
    assert_eq!(job.status, FineTuningStatus::ValidatingFiles);
}

#[test]
fn image_enums_serialize() {
    use openai_oxide::types::image::*;
    let mut req = ImageGenerateRequest::new("test image");
    req.quality = Some(ImageQuality::Hd);
    req.size = Some(ImageSize::S1024x1024);
    req.style = Some(ImageStyle::Natural);
    req.output_format = Some(ImageOutputFormat::Webp);
    req.background = Some(ImageBackground::Transparent);
    req.moderation = Some(ImageModeration::Auto);
    req.response_format = Some(ImageResponseFormat::B64Json);

    let json = serde_json::to_value(&req).unwrap();
    assert_eq!(json["quality"], "hd");
    assert_eq!(json["size"], "1024x1024");
    assert_eq!(json["style"], "natural");
    assert_eq!(json["output_format"], "webp");
    assert_eq!(json["background"], "transparent");
    assert_eq!(json["moderation"], "auto");
    assert_eq!(json["response_format"], "b64_json");
}

#[test]
fn audio_voice_enum_serialize() {
    use openai_oxide::types::audio::*;
    let req = SpeechRequest::new("Hello", "tts-1", AudioVoice::Shimmer);
    let json = serde_json::to_value(&req).unwrap();
    assert_eq!(json["voice"], "shimmer");
}

#[test]
fn encoding_format_enum_serialize() {
    use openai_oxide::types::embedding::*;
    let mut req = EmbeddingRequest::new("text-embedding-3-small", "hello");
    req.encoding_format = Some(EncodingFormat::Base64);
    let json = serde_json::to_value(&req).unwrap();
    assert_eq!(json["encoding_format"], "base64");
}

#[test]
fn auto_or_fixed_round_trip() {
    use openai_oxide::types::common::AutoOrFixed;

    // Auto variant
    let auto: AutoOrFixed<i64> = serde_json::from_str(r#""auto""#).unwrap();
    assert_eq!(auto, AutoOrFixed::Auto);
    assert_eq!(serde_json::to_string(&auto).unwrap(), r#""auto""#);

    // Fixed variant (integer)
    let fixed: AutoOrFixed<i64> = serde_json::from_str("10").unwrap();
    assert_eq!(fixed, AutoOrFixed::Fixed(10));
    assert_eq!(serde_json::to_string(&fixed).unwrap(), "10");

    // Fixed variant (float)
    let fixed_f: AutoOrFixed<f64> = serde_json::from_str("0.5").unwrap();
    assert_eq!(fixed_f, AutoOrFixed::Fixed(0.5));
}

#[test]
fn max_response_tokens_round_trip() {
    use openai_oxide::types::common::MaxResponseTokens;

    // Inf variant
    let inf: MaxResponseTokens = serde_json::from_str(r#""inf""#).unwrap();
    assert_eq!(inf, MaxResponseTokens::Inf);
    assert_eq!(serde_json::to_string(&inf).unwrap(), r#""inf""#);

    // Fixed variant
    let fixed: MaxResponseTokens = serde_json::from_str("4096").unwrap();
    assert_eq!(fixed, MaxResponseTokens::Fixed(4096));
    assert_eq!(serde_json::to_string(&fixed).unwrap(), "4096");
}

#[test]
fn function_call_option_round_trip() {
    use openai_oxide::types::chat::FunctionCallOption;

    // Mode variant
    let mode: FunctionCallOption = serde_json::from_str(r#""auto""#).unwrap();
    assert_eq!(serde_json::to_value(&mode).unwrap(), "auto");

    // Named variant
    let named: FunctionCallOption = serde_json::from_str(r#"{"name": "get_weather"}"#).unwrap();
    assert_eq!(
        serde_json::to_value(&named).unwrap(),
        serde_json::json!({"name": "get_weather"})
    );
}