agen 0.2.1

Provider-neutral orchestration for tool-using LLM applications
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
//! OpenAI Request Builder
//!
//! Converts Open Responses native Item model to OpenAI Chat Completions API format.

use serde::Serialize;
use serde_json::Value;

use crate::{
    llm_client::{
        Request,
        capability::{ModelCapability, ReasoningControl, ReasoningSupport},
        types::{ContentPart, Item, Role, ToolDefinition, image_data_url, parse_tool_arguments},
    },
    tool::Attachment,
};

use super::OpenAIScheme;

/// OpenAI API request body
#[derive(Debug, Serialize)]
pub(crate) struct OpenAIRequest {
    pub model: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_completion_tokens: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_tokens: Option<u32>, // Legacy field for compatibility (e.g. Ollama)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub temperature: Option<f32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub top_p: Option<f32>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub stop: Vec<String>,
    pub stream: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub stream_options: Option<StreamOptions>,
    pub messages: Vec<OpenAIMessage>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub tools: Vec<OpenAITool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tool_choice: Option<String>,
    /// Reasoning effort(o1 / o3 / o4 / gpt-5 系で有効)。
    #[serde(skip_serializing_if = "Option::is_none")]
    pub reasoning_effort: Option<String>,
}

#[derive(Debug, Serialize)]
pub(crate) struct StreamOptions {
    pub include_usage: bool,
}

/// OpenAI message
#[derive(Debug, Serialize)]
pub(crate) struct OpenAIMessage {
    pub role: String,
    pub content: Option<OpenAIContent>,
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub tool_calls: Vec<OpenAIToolCall>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tool_call_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
}

/// OpenAI content
#[allow(dead_code)]
#[derive(Debug, Serialize)]
#[serde(untagged)]
pub(crate) enum OpenAIContent {
    Text(String),
    Parts(Vec<OpenAIContentPart>),
}

/// OpenAI content part
#[allow(dead_code)]
#[derive(Debug, Serialize)]
#[serde(tag = "type")]
pub(crate) enum OpenAIContentPart {
    #[serde(rename = "text")]
    Text { text: String },
    #[serde(rename = "image_url")]
    ImageUrl { image_url: ImageUrl },
}

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

/// OpenAI tool definition
#[derive(Debug, Serialize)]
pub(crate) struct OpenAITool {
    pub r#type: String,
    pub function: OpenAIToolFunction,
}

#[derive(Debug, Serialize)]
pub(crate) struct OpenAIToolFunction {
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    pub parameters: Value,
}

/// OpenAI tool call in message
#[derive(Debug, Serialize)]
pub(crate) struct OpenAIToolCall {
    pub id: String,
    pub r#type: String,
    pub function: OpenAIToolCallFunction,
}

#[derive(Debug, Serialize)]
pub(crate) struct OpenAIToolCallFunction {
    pub name: String,
    pub arguments: String,
}

impl OpenAIScheme {
    /// Build OpenAI request from Request
    pub(crate) fn build_request(
        &self,
        model: &str,
        request: &Request,
        capability: &ModelCapability,
    ) -> OpenAIRequest {
        let mut messages = Vec::new();

        // Add system message if present
        if let Some(system) = &request.system_prompt {
            messages.push(OpenAIMessage {
                role: "system".to_string(),
                content: Some(OpenAIContent::Text(system.clone())),
                tool_calls: vec![],
                tool_call_id: None,
                name: None,
            });
        }

        // Convert items to messages
        messages.extend(self.convert_items_to_messages(&request.items, capability.vision));

        let tools = request.tools.iter().map(|t| self.convert_tool(t)).collect();

        let (max_tokens, max_completion_tokens) = if self.use_legacy_max_tokens {
            (request.config.max_tokens, None)
        } else {
            (None, request.config.max_tokens)
        };

        // Reasoning の投影: capability が Effort / Both をサポートし、
        // request 側で effort が指定されているときだけ reasoning_effort を付ける。
        let supports_effort = matches!(
            capability.reasoning,
            Some(ReasoningSupport::Effort | ReasoningSupport::Both),
        );
        let reasoning_effort = request
            .config
            .reasoning
            .as_ref()
            .filter(|_| supports_effort)
            .and_then(|rc| match rc {
                ReasoningControl::Effort(effort) => Some(effort.as_str().to_string()),
                ReasoningControl::BudgetTokens(_) => None,
            });

        OpenAIRequest {
            model: model.to_string(),
            max_completion_tokens,
            max_tokens,
            temperature: request.config.temperature,
            top_p: request.config.top_p,
            stop: request.config.stop_sequences.clone(),
            stream: true,
            stream_options: Some(StreamOptions {
                include_usage: true,
            }),
            messages,
            tools,
            tool_choice: None,
            reasoning_effort,
        }
    }

    /// Convert Open Responses Items to OpenAI Messages
    ///
    /// OpenAI uses a message-based model where:
    /// - User messages have role "user"
    /// - Assistant messages have role "assistant"
    /// - Tool calls are within assistant messages as tool_calls array
    /// - Tool results have role "tool" with tool_call_id
    fn flush_pending_tool_result_images(
        messages: &mut Vec<OpenAIMessage>,
        pending_images: &mut Vec<OpenAIContentPart>,
    ) {
        if !pending_images.is_empty() {
            messages.push(OpenAIMessage {
                role: "user".to_string(),
                content: Some(OpenAIContent::Parts(std::mem::take(pending_images))),
                tool_calls: vec![],
                tool_call_id: None,
                name: None,
            });
        }
    }

    fn convert_items_to_messages(
        &self,
        items: &[Item],
        supports_images: bool,
    ) -> Vec<OpenAIMessage> {
        let mut messages = Vec::new();
        let mut pending_tool_calls: Vec<OpenAIToolCall> = Vec::new();
        let mut pending_assistant_text: Option<String> = None;
        let mut pending_tool_result_images: Vec<OpenAIContentPart> = Vec::new();

        for item in items {
            if !matches!(item, Item::ToolResult { .. }) {
                Self::flush_pending_tool_result_images(
                    &mut messages,
                    &mut pending_tool_result_images,
                );
            }
            match item {
                Item::Message { role, content, .. } => {
                    // Flush pending tool calls
                    self.flush_pending_assistant(
                        &mut messages,
                        &mut pending_tool_calls,
                        &mut pending_assistant_text,
                    );

                    let openai_role = match role {
                        Role::User => "user",
                        Role::Assistant => "assistant",
                        Role::System => "system",
                    };
                    let message_content = OpenAIContent::Text(
                        content
                            .iter()
                            .map(ContentPart::as_text)
                            .collect::<Vec<_>>()
                            .join(""),
                    );

                    messages.push(OpenAIMessage {
                        role: openai_role.to_string(),
                        content: Some(message_content),
                        tool_calls: vec![],
                        tool_call_id: None,
                        name: None,
                    });
                }

                Item::ToolCall {
                    call_id,
                    name,
                    arguments,
                    ..
                } => {
                    // Normalize non-object / legacy "null" payloads to "{}" so
                    // OpenAI gets a valid JSON object string.
                    let normalized_args = parse_tool_arguments(arguments).to_string();
                    pending_tool_calls.push(OpenAIToolCall {
                        id: call_id.clone(),
                        r#type: "function".to_string(),
                        function: OpenAIToolCallFunction {
                            name: name.clone(),
                            arguments: normalized_args,
                        },
                    });
                }

                Item::ToolResult {
                    call_id,
                    summary,
                    content,
                    attachments,
                    ..
                } => {
                    // OpenAI requires every parallel tool result before a new user message.
                    self.flush_pending_assistant(
                        &mut messages,
                        &mut pending_tool_calls,
                        &mut pending_assistant_text,
                    );

                    let mut text = match content {
                        Some(c) => format!("{summary}\n{c}"),
                        None => summary.clone(),
                    };
                    if supports_images {
                        pending_tool_result_images.extend(attachments.iter().map(|attachment| {
                            let Attachment::Image(image) = attachment;
                            OpenAIContentPart::ImageUrl {
                                image_url: ImageUrl {
                                    url: image_data_url(image.mime_type(), image.data()),
                                },
                            }
                        }));
                    } else if !attachments.is_empty() {
                        text.push_str(&format!(
                            "\n[{} image attachment(s) omitted: model does not support images]",
                            attachments.len()
                        ));
                    }
                    messages.push(OpenAIMessage {
                        role: "tool".to_string(),
                        content: Some(OpenAIContent::Text(text)),
                        tool_calls: vec![],
                        tool_call_id: Some(call_id.clone()),
                        name: None,
                    });
                }

                Item::Reasoning { text, .. } => {
                    // Reasoning is treated as assistant text in OpenAI
                    // (OpenAI doesn't have native reasoning support like Claude)
                    if let Some(ref mut existing) = pending_assistant_text {
                        existing.push_str(text);
                    } else {
                        pending_assistant_text = Some(text.clone());
                    }
                }
            }
        }

        // Flush remaining pending items
        self.flush_pending_assistant(
            &mut messages,
            &mut pending_tool_calls,
            &mut pending_assistant_text,
        );
        Self::flush_pending_tool_result_images(&mut messages, &mut pending_tool_result_images);

        messages
    }

    fn flush_pending_assistant(
        &self,
        messages: &mut Vec<OpenAIMessage>,
        pending_tool_calls: &mut Vec<OpenAIToolCall>,
        pending_assistant_text: &mut Option<String>,
    ) {
        if !pending_tool_calls.is_empty() || pending_assistant_text.is_some() {
            messages.push(OpenAIMessage {
                role: "assistant".to_string(),
                content: pending_assistant_text.take().map(OpenAIContent::Text),
                tool_calls: std::mem::take(pending_tool_calls),
                tool_call_id: None,
                name: None,
            });
        }
    }

    fn convert_tool(&self, tool: &ToolDefinition) -> OpenAITool {
        OpenAITool {
            r#type: "function".to_string(),
            function: OpenAIToolFunction {
                name: tool.name.clone(),
                description: tool.description.clone(),
                parameters: tool.input_schema.clone(),
            },
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::llm_client::capability::{
        CacheStrategy, ReasoningEffort, StructuredOutput, ToolCallingSupport,
    };

    fn cap() -> ModelCapability {
        ModelCapability {
            tool_calling: ToolCallingSupport::Parallel,
            structured_output: StructuredOutput::JsonSchema,
            reasoning: None,
            vision: false,
            prompt_caching: CacheStrategy::Auto,
        }
    }

    fn vision_cap() -> ModelCapability {
        ModelCapability {
            vision: true,
            ..cap()
        }
    }

    #[test]
    fn test_build_simple_request() {
        let scheme = OpenAIScheme::new();
        let request = Request::new().system("System prompt").user("Hello");

        let body = scheme.build_request("gpt-4o", &request, &cap());

        assert_eq!(body.model, "gpt-4o");
        assert_eq!(body.messages.len(), 2);
        assert_eq!(body.messages[0].role, "system");
        assert_eq!(body.messages[1].role, "user");

        if let Some(OpenAIContent::Text(text)) = &body.messages[0].content {
            assert_eq!(text, "System prompt");
        } else {
            panic!("Expected text content");
        }
    }

    #[test]
    fn test_build_request_with_tool() {
        let scheme = OpenAIScheme::new();
        let request = Request::new()
            .user("Check weather")
            .tool(ToolDefinition::new("weather").description("Get weather"));

        let body = scheme.build_request("gpt-4o", &request, &cap());
        assert_eq!(body.tools.len(), 1);
        assert_eq!(body.tools[0].function.name, "weather");
    }

    #[test]
    fn test_build_request_legacy_max_tokens() {
        let scheme = OpenAIScheme::new().with_legacy_max_tokens(true);
        let request = Request::new().user("Hello").max_tokens(100);

        let body = scheme.build_request("llama3", &request, &cap());

        assert_eq!(body.max_tokens, Some(100));
        assert!(body.max_completion_tokens.is_none());
    }

    #[test]
    fn test_build_request_modern_max_tokens() {
        let scheme = OpenAIScheme::new();
        let request = Request::new().user("Hello").max_tokens(100);

        let body = scheme.build_request("gpt-4o", &request, &cap());

        assert_eq!(body.max_completion_tokens, Some(100));
        assert!(body.max_tokens.is_none());
    }

    #[test]
    fn reasoning_effort_projected_when_supported() {
        let scheme = OpenAIScheme::new();
        let mut request = Request::new().user("Hello");
        request.config.reasoning = Some(ReasoningControl::Effort(ReasoningEffort::Other(
            "provider-native".into(),
        )));
        let capability = ModelCapability {
            reasoning: Some(ReasoningSupport::Effort),
            ..cap()
        };

        let body = scheme.build_request("gpt-5", &request, &capability);

        assert_eq!(body.reasoning_effort.as_deref(), Some("provider-native"));
    }

    #[test]
    fn budget_reasoning_not_projected_to_openai_chat() {
        let scheme = OpenAIScheme::new();
        let mut request = Request::new().user("Hello");
        request.config.reasoning = Some(ReasoningControl::BudgetTokens(4096));
        let capability = ModelCapability {
            reasoning: Some(ReasoningSupport::Both),
            ..cap()
        };

        let body = scheme.build_request("gpt-5", &request, &capability);

        assert!(body.reasoning_effort.is_none());
    }

    #[test]
    fn test_tool_call_and_result() {
        let scheme = OpenAIScheme::new();
        let request = Request::new()
            .user("Check weather")
            .item(Item::tool_call(
                "call_123",
                "get_weather",
                r#"{"city":"Tokyo"}"#,
            ))
            .item(Item::tool_result("call_123", "Sunny, 25°C"));

        let body = scheme.build_request("gpt-4o", &request, &cap());

        assert_eq!(body.messages.len(), 3);
        assert_eq!(body.messages[0].role, "user");
        assert_eq!(body.messages[1].role, "assistant");
        assert_eq!(body.messages[1].tool_calls.len(), 1);
        assert_eq!(body.messages[2].role, "tool");
    }

    #[test]
    fn parallel_tool_results_precede_durable_image_projection() {
        let scheme = OpenAIScheme::new();
        let image = std::sync::Arc::<[u8]>::from(&b"\x89PNG\r\n\x1a\nbody"[..]);
        let request = Request::new()
            .item(Item::tool_call("call_image", "ViewImage", "{}"))
            .item(Item::tool_call("call_text", "Read", "{}"))
            .item(Item::tool_result_item_with_attachments(
                "call_image",
                "Attached image",
                None,
                false,
                vec![crate::tool::Attachment::Image(
                    crate::tool::ImageAttachment::new("image/png", image),
                )],
            ))
            .item(Item::tool_result_item(
                "call_text",
                "Read text",
                None,
                false,
            ));
        let json = serde_json::to_value(
            &scheme
                .build_request("gpt-4o", &request, &vision_cap())
                .messages,
        )
        .unwrap();

        assert_eq!(json[0]["role"], "assistant");
        assert_eq!(json[1]["role"], "tool");
        assert_eq!(json[2]["role"], "tool");
        assert_eq!(json[3]["role"], "user");
        assert_eq!(json[3]["content"][0]["type"], "image_url");
    }

    #[test]
    fn durable_tool_image_is_deterministically_lowered_to_following_user_content() {
        let scheme = OpenAIScheme::new();
        let image = std::sync::Arc::<[u8]>::from(&b"\x89PNG\r\n\x1a\nbody"[..]);
        let attachment = crate::tool::Attachment::Image(crate::tool::ImageAttachment::new(
            "image/png",
            image.clone(),
        ));
        let item = Item::tool_result_item_with_attachments(
            "call_image",
            "Attached image",
            None,
            false,
            vec![attachment],
        );
        let persisted = serde_json::to_string(&item).unwrap();
        assert!(persisted.contains("attachments"));
        let restored: Item = serde_json::from_str(&persisted).unwrap();

        let request = Request::new()
            .item(Item::tool_call(
                "call_image",
                "ViewImage",
                r#"{"path":"a.png"}"#,
            ))
            .item(restored);
        let body = scheme.build_request("gpt-4o", &request, &vision_cap());
        let json = serde_json::to_value(&body.messages).unwrap();
        let rebuilt = serde_json::to_value(
            &scheme
                .build_request("gpt-4o", &request, &vision_cap())
                .messages,
        )
        .unwrap();
        assert_eq!(rebuilt, json);

        assert_eq!(json[0]["role"], "assistant");
        assert_eq!(json[1]["role"], "tool");
        assert_eq!(json[2]["role"], "user");
        assert_eq!(json[2]["content"][0]["type"], "image_url");
        assert!(
            json[2]["content"][0]["image_url"]["url"]
                .as_str()
                .unwrap()
                .starts_with("data:image/png;base64,")
        );

        let mut no_vision = cap();
        no_vision.vision = false;
        let disabled =
            serde_json::to_string(&scheme.build_request("gpt-4o", &request, &no_vision)).unwrap();
        assert!(!disabled.contains("data:image"));
    }
}