aisdk 0.5.2

An open-source Rust library for building AI-powered applications, inspired by the Vercel AI SDK. It provides a robust, type-safe, and easy-to-use interface for interacting with various Large Language Models (LLMs).
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

//! Defines the core error and result types for the SDK.
//!
//! # Examples
//!
//! ```
//! use aisdk::error::{Result, Error};
//!
//! fn might_fail(should_fail: bool) -> Result<()> {
//!     if should_fail {
//!         Err(Error::Other("Something went wrong".to_string()))
//!     } else {
//!         Ok(())
//!     }
//! }
//! ```

use std::sync::Arc;

use derive_builder::UninitializedFieldError;

/// A marker trait for provider-specific errors.
pub trait ProviderError: std::error::Error + Send + Sync {}

impl PartialEq for dyn ProviderError {
    fn eq(&self, other: &dyn ProviderError) -> bool {
        self.to_string() == other.to_string()
    }
}

/// A specialized `Result` type for SDK operations.
pub type Result<T> = std::result::Result<T, Error>;

/// The primary error enum for all AI SDK related failures.
#[derive(Debug, thiserror::Error, Clone, PartialEq)]
pub enum Error {
    /// Error indicating a required field was missing.
    #[error("A required field is missing: {0}")]
    MissingField(String),

    /// An error returned from the API.
    #[error("API error: {status_code:?} - {details}")]
    ApiError {
        /// The error details/message.
        details: String,
        /// The HTTP status code, if available.
        status_code: Option<reqwest::StatusCode>,
    },

    /// An error for invalid input.
    #[error("Invalid input: {0}")]
    InvalidInput(String),

    /// An error related to tool execution. This includes errors caused by the
    /// tool itself as well by the SDK when interacting with the tool.
    #[error("Tool error: {0}")]
    ToolCallError(String),

    /// An error related to prompt template processing and rendering.
    #[error("Prompt error: {0}")]
    PromptError(String),

    /// A catch-all for other miscellaneous errors.
    #[error("AI SDK error: {0}")]
    Other(String),

    /// Provider-specific error.
    #[error("Provider error: {0}")]
    ProviderError(Arc<dyn ProviderError>),
}

/// Implements `From` for `UninitializedFieldError` to convert it to `Error`.
/// Mainly used for the `derive_builder` crate.
impl From<UninitializedFieldError> for Error {
    fn from(err: UninitializedFieldError) -> Self {
        Error::MissingField(err.field_name().to_string())
    }
}

impl From<Error> for String {
    fn from(value: Error) -> String {
        match value {
            Error::MissingField(error) => format!("Missing field: {error}"),
            Error::ApiError {
                details,
                status_code,
            } => {
                format!("API error: {status_code:?} - {details}")
            }
            Error::InvalidInput(error) => format!("Invalid input: {error}"),
            Error::ToolCallError(error) => format!("Tool error: {error}"),
            Error::Other(error) => format!("Other error: {error}"),
            Error::ProviderError(error) => format!("Provider error: {error}"),
            Error::PromptError(error) => format!("Prompt error: {error}"),
        }
    }
}