aither 0.2.0

Providing unified trait abstractions for AI models
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

//! # Tool Macro Examples
//!
//! This example demonstrates various ways to use the `#[tool]` macro from `aither-derive`
//! to convert async functions into AI tools.
//!
//! Run this example with: `cargo run --example tool_macro`

#![allow(clippy::missing_errors_doc)]
#![allow(missing_docs)]
#![allow(clippy::unused_async)]
use aither::Result;
use aither_derive::tool;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

// Basic tool example - no parameters needed
#[tool(description = "Get current time in UTC")]
pub async fn time() -> Result<&'static str> {
    Ok("2023-10-01T12:00:00Z")
}

/// Return type for search results
#[derive(Debug, Serialize)]
pub struct SearchResult {
    title: String,
    url: String,
}

// Tool with multiple simple parameters
#[tool(description = "Search on the web")]
pub async fn search(keywords: Vec<String>, max_results: u32) -> Result<Vec<SearchResult>> {
    // Simulate a search result
    let results = keywords
        .into_iter()
        .take(max_results as usize)
        .map(|keyword| SearchResult {
            title: format!("Result for {keyword}",),
            url: format!("https://example.com/search?q={keyword}",),
        })
        .collect();
    Ok(results)
}

/// Arguments for image generation with comprehensive documentation
#[derive(Debug, JsonSchema, Deserialize)]
pub struct GenerateImageArgs {
    /// The prompt for the image generation.
    pub prompt: String,
    /// Optional images to guide the generation process.
    pub images: Vec<String>,
}

// Tool with complex documented arguments using a single struct parameter
#[tool(description = "Generate an image from a text prompt")]
pub async fn generate_image(args: GenerateImageArgs) -> aither::Result<String> {
    let file_name = format!("image_{}.png", args.prompt.replace(' ', "_"));
    // Simulate image generation
    Ok(format!(
        "Generated image '{file_name}' with prompt '{}'",
        args.prompt
    ))
}

fn main() {}