openai-ergonomic 0.5.2

Ergonomic Rust wrapper for 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
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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
//! Comprehensive integration tests for all builders in the openai-ergonomic crate.
//!
//! This module tests all builder patterns including chat builders, responses builders,
//! and their various configurations and edge cases.

#![allow(
    dead_code,
    unused_imports,
    clippy::cast_possible_truncation,
    clippy::significant_drop_tightening,
    clippy::doc_markdown,
    clippy::redundant_clone,
    clippy::uninlined_format_args,
    clippy::manual_let_else,
    clippy::match_wildcard_for_single_variants
)]

mod harness;

use harness::{assert_valid_chat_request, fixtures, model_test_cases, parameter_validation_tests};
use openai_client_base::models::ChatCompletionRequestUserMessageContentPart;
use openai_ergonomic::{
    builders::{
        chat::{image_url_part, system_user, text_part, tool_function, ChatCompletionBuilder},
        responses::{
            responses_simple, responses_system_user, responses_tool_function, ResponsesBuilder,
        },
        Builder,
    },
    errors::Error,
    Detail,
};
use serde_json::json;
use std::time::Duration;

/// Test comprehensive chat builder functionality
#[test]
fn test_chat_builder_comprehensive() {
    // Test basic chat builder
    let basic_builder = ChatCompletionBuilder::new("gpt-4").user("Hello, world!");

    let request = assert_builder_success!(basic_builder);
    assert_valid_chat_request(&request);
    assert_eq!(request.model, "gpt-4");
    assert_eq!(request.messages.len(), 1);
}

/// Test chat builder with all parameters
#[test]
fn test_chat_builder_all_parameters() {
    let tool = tool_function(
        "test_tool",
        "A test tool",
        json!({
            "type": "object",
            "properties": {
                "param": {"type": "string"}
            }
        }),
    );

    let builder = ChatCompletionBuilder::new("gpt-4")
        .system("You are a helpful assistant")
        .user("Help me with testing")
        .temperature(0.7)
        .max_tokens(500)
        .max_completion_tokens(400)
        .top_p(0.9)
        .frequency_penalty(0.1)
        .presence_penalty(0.1)
        .n(1)
        .stop(vec!["STOP".to_string(), "END".to_string()])
        .tools(vec![tool])
        .user_id("test-user")
        .seed(12345);

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert_eq!(request.model, "gpt-4");
    assert_eq!(request.messages.len(), 2);
    assert_eq!(request.temperature, Some(0.7));
    assert_eq!(request.max_tokens, Some(500));
    assert_eq!(request.max_completion_tokens, Some(400));
    assert_eq!(request.top_p, Some(0.9));
    assert_eq!(request.frequency_penalty, Some(0.1));
    assert_eq!(request.presence_penalty, Some(0.1));
    assert_eq!(request.n, Some(1));
    assert_eq!(request.seed, Some(12345));
    assert!(request.stop.is_some());
    assert!(request.tools.is_some());
    assert_eq!(request.user, Some("test-user".to_string()));
}

/// Test responses builder comprehensive functionality
#[test]
fn test_responses_builder_comprehensive() {
    let tool = responses_tool_function(
        "search",
        "Search for information",
        json!({
            "type": "object",
            "properties": {
                "query": {"type": "string"}
            }
        }),
    );

    let builder = responses_system_user(
        "gpt-4",
        "You are a search assistant",
        "Find information about Rust",
    )
    .temperature(0.8)
    .max_completion_tokens(500)
    .tool(tool)
    .json_mode()
    .stream(true);

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert_eq!(request.model, "gpt-4");
    assert_eq!(request.messages.len(), 2);
    assert_eq!(request.temperature, Some(0.8));
    assert_eq!(request.max_completion_tokens, Some(500));
    assert!(request.tools.is_some());
    assert!(request.response_format.is_some());
    assert_eq!(request.stream, Some(true));
}

/// Test vision/multimodal chat builder
#[test]
fn test_chat_builder_vision() {
    let text_part = text_part("What do you see in this image?");
    let image_part = image_url_part("https://example.com/image.jpg");
    let image_with_detail = openai_ergonomic::builders::chat::image_url_part_with_detail(
        "https://example.com/detailed.jpg",
        Detail::High,
    );

    let builder = ChatCompletionBuilder::new("gpt-4-vision-preview").user_with_parts(vec![
        text_part,
        image_part,
        image_with_detail,
    ]);

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert_eq!(request.model, "gpt-4-vision-preview");
    assert_eq!(request.messages.len(), 1);

    // Verify the message content structure
    if let Some(
        openai_client_base::models::ChatCompletionRequestMessage::ChatCompletionRequestUserMessage(
            user_msg,
        ),
    ) = request.messages.first()
    {
        match user_msg.content.as_ref() {
            openai_client_base::models::ChatCompletionRequestUserMessageContent::ArrayOfContentParts(parts) => {
                assert_eq!(parts.len(), 3);

                // Check text part
                match &parts[0] {
                    ChatCompletionRequestUserMessageContentPart::ChatCompletionRequestMessageContentPartText(text) => {
                        assert_eq!(text.text, "What do you see in this image?");
                    }
                    _ => panic!("Expected text part"),
                }

                // Check image parts
                for (i, part) in parts.iter().skip(1).enumerate() {
                    match part {
                        ChatCompletionRequestUserMessageContentPart::ChatCompletionRequestMessageContentPartImage(img) => {
                            assert!(img.image_url.url.starts_with("https://"));
                            if i == 1 {
                                assert_eq!(img.image_url.detail, Some(Detail::High));
                            }
                        }
                        _ => panic!("Expected image part"),
                    }
                }
            }
            _ => panic!("Expected array content for multimodal message"),
        }
    } else {
        panic!("Expected user message");
    }
}

/// Test base64 image handling
#[test]
fn test_base64_image_handling() {
    let base64_data = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8/5+hHgAHggJ/PchI7wAAAABJRU5ErkJggg==";
    let media_type = "image/png";

    let image_part = openai_ergonomic::builders::chat::image_base64_part(base64_data, media_type);

    match image_part {
        ChatCompletionRequestUserMessageContentPart::ChatCompletionRequestMessageContentPartImage(img) => {
            assert!(img.image_url.url.starts_with("data:image/png;base64,"));
            assert!(img.image_url.url.contains(base64_data));
        }
        _ => panic!("Expected image part"),
    }
}

/// Test JSON schema functionality
#[test]
fn test_json_schema_builder() {
    let schema = json!({
        "type": "object",
        "properties": {
            "name": {"type": "string"},
            "age": {"type": "number"},
            "email": {"type": "string", "format": "email"}
        },
        "required": ["name", "age"]
    });

    let builder =
        responses_simple("gpt-4", "Generate a person object").json_schema("person", schema.clone());

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert!(request.response_format.is_some());
    let response_format = request.response_format.unwrap();
    let schema_format = match response_format.as_ref() {
        openai_client_base::models::CreateChatCompletionRequestAllOfResponseFormat::ResponseFormatJsonSchema(format) => format,
        other => panic!("expected json schema response format, got {other:?}"),
    };
    assert_eq!(schema_format.json_schema.name, "person");
    assert!(schema_format.json_schema.schema.is_some());
}

/// Test reasoning effort parameter for o3 models
#[test]
fn test_reasoning_effort_parameter() {
    let builder = ResponsesBuilder::new("o3-mini")
        .user("Solve this complex problem")
        .reasoning_effort("high");

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert_eq!(request.model, "o3-mini");
    // Note: Reasoning effort validation simplified due to enum type changes
    assert!(request.reasoning_effort.is_some());
}

/// Test parameter validation with boundary values
#[test]
fn test_parameter_boundary_validation() {
    let boundary_tests = parameter_validation_tests();

    for (test_name, value, should_be_valid) in boundary_tests {
        match test_name {
            name if name.starts_with("temperature") => {
                let builder = ChatCompletionBuilder::new("gpt-4")
                    .user("test")
                    .temperature(value);

                if should_be_valid {
                    let request = assert_builder_success!(builder);
                    assert_eq!(request.temperature, Some(value));
                } else {
                    let result = builder.build();
                    assert!(result.is_err(), "Temperature {value} should be invalid");
                }
            }
            name if name.starts_with("top_p") => {
                let builder = ChatCompletionBuilder::new("gpt-4")
                    .user("test")
                    .top_p(value);

                if should_be_valid {
                    let request = assert_builder_success!(builder);
                    assert_eq!(request.top_p, Some(value));
                } else {
                    let result = builder.build();
                    assert!(result.is_err(), "Top-p {value} should be invalid");
                }
            }
            name if name.starts_with("frequency_penalty") => {
                let builder = ChatCompletionBuilder::new("gpt-4")
                    .user("test")
                    .frequency_penalty(value);

                if should_be_valid {
                    let request = assert_builder_success!(builder);
                    assert_eq!(request.frequency_penalty, Some(value));
                } else {
                    let result = builder.build();
                    assert!(
                        result.is_err(),
                        "Frequency penalty {value} should be invalid"
                    );
                }
            }
            name if name.starts_with("presence_penalty") => {
                let builder = ChatCompletionBuilder::new("gpt-4")
                    .user("test")
                    .presence_penalty(value);

                if should_be_valid {
                    let request = assert_builder_success!(builder);
                    assert_eq!(request.presence_penalty, Some(value));
                } else {
                    let result = builder.build();
                    assert!(
                        result.is_err(),
                        "Presence penalty {value} should be invalid"
                    );
                }
            }
            _ => {} // Skip unknown parameter types
        }
    }
}

/// Test different model configurations
#[test]
fn test_model_configurations() {
    let model_tests = model_test_cases();

    for (_test_name, model) in model_tests {
        let builder = ChatCompletionBuilder::new(model).user("Test message");

        let request = assert_builder_success!(builder);
        assert_valid_chat_request(&request);
        assert_eq!(request.model, model);
    }
}

/// Test builder validation errors
#[test]
fn test_builder_validation_errors() {
    // Test empty messages
    let empty_builder = ChatCompletionBuilder::new("gpt-4");
    let result = empty_builder.build();
    assert!(result.is_err());
    match result {
        Err(Error::InvalidRequest(msg)) => {
            assert!(msg.contains("At least one message is required"));
        }
        _ => panic!("Expected InvalidRequest error"),
    }

    // Test empty model
    let empty_model_builder = ChatCompletionBuilder::new("").user("Test message");
    let result = empty_model_builder.build();
    assert!(result.is_err());
}

/// Test helper function consistency between modules
#[test]
fn test_helper_function_consistency() {
    let function_name = "test_function";
    let description = "A test function";
    let parameters = json!({"type": "object", "properties": {}});

    // Create tools using both modules
    let chat_tool = tool_function(function_name, description, parameters.clone());
    let responses_tool = responses_tool_function(function_name, description, parameters);

    // Both should create equivalent tools
    assert_eq!(chat_tool.function.name, responses_tool.function.name);
    assert_eq!(
        chat_tool.function.description,
        responses_tool.function.description
    );
    assert_eq!(
        chat_tool.function.parameters,
        responses_tool.function.parameters
    );
}

/// Test complex conversation building
#[test]
fn test_complex_conversation_building() {
    let mut builder = ChatCompletionBuilder::new("gpt-4").system("You are a helpful assistant");

    // Build a conversation step by step
    builder = builder.user("What is 2+2?");
    builder = builder.assistant("2+2 equals 4.");
    builder = builder.user("What about 3+3?");

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert_eq!(request.messages.len(), 4);
    assert_eq!(request.model, "gpt-4");
}

/// Test function calling with complex parameters
#[test]
fn test_complex_function_calling() {
    let complex_tool = tool_function(
        "search_database",
        "Search through a database with filters",
        json!({
            "type": "object",
            "properties": {
                "query": {
                    "type": "string",
                    "description": "Search query"
                },
                "filters": {
                    "type": "object",
                    "properties": {
                        "category": {
                            "type": "string",
                            "enum": ["books", "movies", "music"]
                        },
                        "min_rating": {
                            "type": "number",
                            "minimum": 0,
                            "maximum": 10
                        }
                    }
                },
                "limit": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 100,
                    "default": 10
                }
            },
            "required": ["query"]
        }),
    );

    let builder = system_user(
        "gpt-4",
        "You are a search assistant",
        "Find me some good books",
    )
    .tools(vec![complex_tool]);

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert!(request.tools.is_some());
    let tools = request.tools.unwrap();
    assert_eq!(tools.len(), 1);
    // Note: Tool structure validation simplified due to API changes
}

/// Test streaming configuration
#[test]
fn test_streaming_configuration() {
    let builder = responses_simple("gpt-4", "Tell me a story")
        .stream(true)
        .max_tokens(200);

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert_eq!(request.stream, Some(true));
    assert_eq!(request.max_tokens, Some(200));
}

/// Test JSON mode configuration
#[test]
fn test_json_mode_configuration() {
    let builder = responses_simple("gpt-4", "Generate a JSON object").json_mode();

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    // Note: Response format validation removed due to API structure changes
    assert!(request.response_format.is_some());
}

/// Test stop sequences configuration
#[test]
fn test_stop_sequences() {
    let stop_sequences = vec!["STOP".to_string(), "END".to_string(), "DONE".to_string()];

    let builder = ChatCompletionBuilder::new("gpt-4")
        .user("Count to 10")
        .stop(stop_sequences.clone());

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert!(request.stop.is_some());
}

/// Test that requests are serializable
#[test]
fn test_request_serialization() {
    let tool = responses_tool_function(
        "calculate",
        "Perform calculations",
        json!({
            "type": "object",
            "properties": {
                "expression": {"type": "string"}
            }
        }),
    );

    let builder = responses_system_user("gpt-4", "You are a math assistant", "Calculate 2+2")
        .temperature(0.7)
        .max_completion_tokens(100)
        .tool(tool)
        .json_mode();

    let request = assert_builder_success!(builder);

    // Test serialization
    let json_result = serde_json::to_string(&request);
    assert!(json_result.is_ok());

    let json_string = json_result.unwrap();
    assert!(json_string.contains("gpt-4"));
    assert!(json_string.contains("calculate"));
    assert!(json_string.contains("temperature"));
}

/// Performance test for builder operations
#[test]
fn test_builder_performance() {
    use harness::assert_performance;

    let _request = assert_performance(
        || {
            let tool = tool_function("test", "test", json!({"type": "object", "properties": {}}));

            ChatCompletionBuilder::new("gpt-4")
                .system("System message")
                .user("User message")
                .temperature(0.7)
                .max_tokens(100)
                .tools(vec![tool])
                .build()
                .unwrap()
        },
        Duration::from_millis(10),
        "builder_creation_and_build",
    );
}

/// Test with fixtures from the harness
#[test]
fn test_with_fixtures() {
    let _chat_fixture = fixtures::chat_requests::with_functions();

    // Verify we can create a similar request with our builders
    let tool = tool_function(
        "get_weather",
        "Get current weather information",
        json!({
            "type": "object",
            "properties": {
                "location": {
                    "type": "string",
                    "description": "The location to get weather for"
                },
                "units": {
                    "type": "string",
                    "enum": ["celsius", "fahrenheit"],
                    "description": "Temperature units"
                }
            },
            "required": ["location"]
        }),
    );

    let builder = ChatCompletionBuilder::new("gpt-4")
        .user("What's the weather in Paris?")
        .tools(vec![tool]);

    let request = assert_builder_success!(builder);
    assert_valid_chat_request(&request);

    assert_eq!(request.model, "gpt-4");
    assert_eq!(request.messages.len(), 1);
    assert!(request.tools.is_some());
    assert_eq!(request.tools.as_ref().unwrap().len(), 1);
}

/// Test error handling in builders
#[test]
fn test_builder_error_handling() {
    // Test with invalid model (empty string)
    let invalid_model_builder = ResponsesBuilder::new("").user("Test");

    let result = invalid_model_builder.build();
    assert!(result.is_err());

    // Test with no messages
    let no_messages_builder = ResponsesBuilder::new("gpt-4");
    let result = no_messages_builder.build();
    assert!(result.is_err());
}

/// Test all detail levels for images
#[test]
fn test_all_image_detail_levels() {
    let details = vec![Detail::Auto, Detail::Low, Detail::High];

    for detail in details {
        let image_part = openai_ergonomic::builders::chat::image_url_part_with_detail(
            "https://example.com/test.jpg",
            detail,
        );

        match image_part {
            ChatCompletionRequestUserMessageContentPart::ChatCompletionRequestMessageContentPartImage(img) => {
                assert_eq!(img.image_url.detail, Some(detail));
                assert!(img.image_url.url.starts_with("https://"));
            }
            _ => panic!("Expected image part"),
        }
    }
}