orra 0.0.2

Context-aware agent session management for any application
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
//! Image generation tool.
//!
//! Provides a tool that wraps image generation APIs (OpenAI DALL-E, Stability AI,
//! etc.) behind a common interface. The actual HTTP calls are abstracted behind
//! the `ImageProvider` trait so different backends can be plugged in.

use std::sync::Arc;

use async_trait::async_trait;

use crate::tool::{Tool, ToolDefinition, ToolError, ToolRegistry};

// ---------------------------------------------------------------------------
// Image provider trait
// ---------------------------------------------------------------------------

/// Result of an image generation request.
#[derive(Debug, Clone)]
pub struct GeneratedImage {
    /// URL where the generated image can be accessed.
    pub url: String,

    /// Revised prompt (some providers rewrite the prompt for safety/quality).
    pub revised_prompt: Option<String>,
}

/// Trait for image generation backends.
#[async_trait]
pub trait ImageProvider: Send + Sync {
    /// Generate an image from a text prompt.
    async fn generate(
        &self,
        prompt: &str,
        options: &ImageOptions,
    ) -> Result<GeneratedImage, ImageGenError>;
}

/// Options for image generation.
#[derive(Debug, Clone)]
pub struct ImageOptions {
    /// Desired image size (e.g., "1024x1024", "512x512").
    pub size: String,

    /// Style hint (e.g., "vivid", "natural"). Provider-specific.
    pub style: Option<String>,

    /// Quality hint (e.g., "standard", "hd"). Provider-specific.
    pub quality: Option<String>,
}

impl Default for ImageOptions {
    fn default() -> Self {
        Self {
            size: "1024x1024".into(),
            style: None,
            quality: None,
        }
    }
}

// ---------------------------------------------------------------------------
// OpenAI DALL-E provider
// ---------------------------------------------------------------------------

/// Image generation using OpenAI's DALL-E API.
pub struct DallEProvider {
    client: reqwest::Client,
    api_key: String,
    model: String,
    api_url: String,
}

impl DallEProvider {
    pub fn new(api_key: impl Into<String>) -> Self {
        Self {
            client: reqwest::Client::new(),
            api_key: api_key.into(),
            model: "dall-e-3".into(),
            api_url: "https://api.openai.com/v1/images/generations".into(),
        }
    }

    pub fn with_model(mut self, model: impl Into<String>) -> Self {
        self.model = model.into();
        self
    }

    pub fn with_api_url(mut self, url: impl Into<String>) -> Self {
        self.api_url = url.into();
        self
    }
}

#[async_trait]
impl ImageProvider for DallEProvider {
    async fn generate(
        &self,
        prompt: &str,
        options: &ImageOptions,
    ) -> Result<GeneratedImage, ImageGenError> {
        let mut body = serde_json::json!({
            "model": self.model,
            "prompt": prompt,
            "n": 1,
            "size": options.size,
            "response_format": "url",
        });

        if let Some(ref quality) = options.quality {
            body["quality"] = serde_json::json!(quality);
        }
        if let Some(ref style) = options.style {
            body["style"] = serde_json::json!(style);
        }

        let response = self
            .client
            .post(&self.api_url)
            .header("Authorization", format!("Bearer {}", self.api_key))
            .json(&body)
            .send()
            .await
            .map_err(|e| ImageGenError::Request(e.to_string()))?;

        if !response.status().is_success() {
            let status = response.status().as_u16();
            let text = response.text().await.unwrap_or_default();
            return Err(ImageGenError::Api {
                status,
                message: text,
            });
        }

        let data: serde_json::Value = response
            .json()
            .await
            .map_err(|e| ImageGenError::Parse(e.to_string()))?;

        let image_data = data["data"]
            .as_array()
            .and_then(|arr| arr.first())
            .ok_or_else(|| ImageGenError::Parse("no images in response".into()))?;

        let url = image_data["url"]
            .as_str()
            .ok_or_else(|| ImageGenError::Parse("missing image url".into()))?
            .to_string();

        let revised_prompt = image_data["revised_prompt"]
            .as_str()
            .map(|s| s.to_string());

        Ok(GeneratedImage {
            url,
            revised_prompt,
        })
    }
}

// ---------------------------------------------------------------------------
// Image generation tool
// ---------------------------------------------------------------------------

/// Agent-facing tool for generating images from text descriptions.
pub struct ImageGenTool {
    provider: Arc<dyn ImageProvider>,
}

impl ImageGenTool {
    pub fn new(provider: Arc<dyn ImageProvider>) -> Self {
        Self { provider }
    }
}

#[async_trait]
impl Tool for ImageGenTool {
    fn definition(&self) -> ToolDefinition {
        ToolDefinition {
            name: "generate_image".into(),
            description: "Generate an image from a text description. Returns a URL to the \
                          generated image."
                .into(),
            input_schema: serde_json::json!({
                "type": "object",
                "properties": {
                    "prompt": {
                        "type": "string",
                        "description": "A detailed description of the image to generate"
                    },
                    "size": {
                        "type": "string",
                        "description": "Image size (e.g., '1024x1024', '1792x1024'). Default: 1024x1024",
                        "enum": ["1024x1024", "1792x1024", "1024x1792"]
                    },
                    "style": {
                        "type": "string",
                        "description": "Image style: 'vivid' for dramatic, 'natural' for realistic",
                        "enum": ["vivid", "natural"]
                    },
                    "quality": {
                        "type": "string",
                        "description": "Quality level: 'standard' or 'hd'",
                        "enum": ["standard", "hd"]
                    }
                },
                "required": ["prompt"]
            }),
        }
    }

    async fn execute(&self, input: serde_json::Value) -> Result<String, ToolError> {
        let prompt = input
            .get("prompt")
            .and_then(|v| v.as_str())
            .ok_or_else(|| ToolError::InvalidInput("missing 'prompt'".into()))?;

        let size = input
            .get("size")
            .and_then(|v| v.as_str())
            .unwrap_or("1024x1024")
            .to_string();

        let style = input.get("style").and_then(|v| v.as_str()).map(String::from);
        let quality = input
            .get("quality")
            .and_then(|v| v.as_str())
            .map(String::from);

        let options = ImageOptions {
            size,
            style,
            quality,
        };

        let result = self
            .provider
            .generate(prompt, &options)
            .await
            .map_err(|e| ToolError::ExecutionFailed(e.to_string()))?;

        let mut output = format!("Generated image: {}", result.url);
        if let Some(revised) = &result.revised_prompt {
            output.push_str(&format!("\nRevised prompt: {}", revised));
        }

        Ok(output)
    }
}

/// Register the image generation tool.
pub fn register_tool(registry: &mut ToolRegistry, provider: Arc<dyn ImageProvider>) {
    registry.register(Box::new(ImageGenTool::new(provider)));
}

// ---------------------------------------------------------------------------
// Errors
// ---------------------------------------------------------------------------

#[derive(Debug, thiserror::Error)]
pub enum ImageGenError {
    #[error("request failed: {0}")]
    Request(String),

    #[error("API error (status {status}): {message}")]
    Api { status: u16, message: String },

    #[error("failed to parse response: {0}")]
    Parse(String),
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;

    // Mock image provider for testing
    struct MockImageProvider {
        url: String,
    }

    #[async_trait]
    impl ImageProvider for MockImageProvider {
        async fn generate(
            &self,
            prompt: &str,
            _options: &ImageOptions,
        ) -> Result<GeneratedImage, ImageGenError> {
            Ok(GeneratedImage {
                url: self.url.clone(),
                revised_prompt: Some(format!("A beautiful {}", prompt)),
            })
        }
    }

    struct FailingImageProvider;

    #[async_trait]
    impl ImageProvider for FailingImageProvider {
        async fn generate(
            &self,
            _prompt: &str,
            _options: &ImageOptions,
        ) -> Result<GeneratedImage, ImageGenError> {
            Err(ImageGenError::Api {
                status: 429,
                message: "rate limited".into(),
            })
        }
    }

    #[tokio::test]
    async fn image_gen_tool_basic() {
        let provider = Arc::new(MockImageProvider {
            url: "https://example.com/image.png".into(),
        });
        let tool = ImageGenTool::new(provider);

        let result = tool
            .execute(serde_json::json!({
                "prompt": "a sunset over mountains"
            }))
            .await
            .unwrap();

        assert!(result.contains("https://example.com/image.png"));
        assert!(result.contains("Revised prompt"));
    }

    #[tokio::test]
    async fn image_gen_tool_with_options() {
        let provider = Arc::new(MockImageProvider {
            url: "https://example.com/img.png".into(),
        });
        let tool = ImageGenTool::new(provider);

        let result = tool
            .execute(serde_json::json!({
                "prompt": "a cat",
                "size": "1792x1024",
                "style": "vivid",
                "quality": "hd"
            }))
            .await
            .unwrap();

        assert!(result.contains("https://example.com/img.png"));
    }

    #[tokio::test]
    async fn image_gen_tool_missing_prompt() {
        let provider = Arc::new(MockImageProvider {
            url: "https://example.com/img.png".into(),
        });
        let tool = ImageGenTool::new(provider);

        let err = tool.execute(serde_json::json!({})).await.unwrap_err();
        assert!(matches!(err, ToolError::InvalidInput(_)));
    }

    #[tokio::test]
    async fn image_gen_tool_provider_error() {
        let provider = Arc::new(FailingImageProvider);
        let tool = ImageGenTool::new(provider);

        let err = tool
            .execute(serde_json::json!({"prompt": "test"}))
            .await
            .unwrap_err();
        assert!(matches!(err, ToolError::ExecutionFailed(_)));
    }

    #[test]
    fn tool_definition_valid() {
        let provider = Arc::new(MockImageProvider {
            url: "test".into(),
        });
        let tool = ImageGenTool::new(provider);
        let def = tool.definition();

        assert_eq!(def.name, "generate_image");
        assert!(def.input_schema["required"]
            .as_array()
            .unwrap()
            .contains(&serde_json::json!("prompt")));
    }

    #[test]
    fn default_image_options() {
        let opts = ImageOptions::default();
        assert_eq!(opts.size, "1024x1024");
        assert!(opts.style.is_none());
        assert!(opts.quality.is_none());
    }

    #[test]
    fn image_gen_error_display() {
        let err = ImageGenError::Api {
            status: 400,
            message: "bad prompt".into(),
        };
        assert!(err.to_string().contains("400"));
        assert!(err.to_string().contains("bad prompt"));
    }
}