baml 0.219.0

BAML runtime for Rust - type-safe LLM function calls
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

//! Media types (Image, Audio, Pdf, Video)
//!
//! These wrap FFI pointers to media objects managed by the BAML runtime.

use std::ffi::c_void;

use super::{RawObject, RawObjectTrait};
use crate::{baml_unreachable, proto::baml_cffi_v1::BamlObjectType};

// =============================================================================
// Media type macro - generates Image, Audio, Pdf, Video
// Uses define_raw_object_wrapper for base struct + from_raw + RawObjectTrait
// =============================================================================

macro_rules! define_media_type {
    (
        $(#[$meta:meta])*
        $name:ident => $object_type:ident
    ) => {
        // Use the base wrapper for struct, from_raw, and RawObjectTrait
        define_raw_object_wrapper! {
            $(#[$meta])*
            $name => $object_type
        }

        // Add media-specific constructors and methods
        impl $name {
            /// Create from a URL
            pub fn from_url(runtime: *const c_void, url: &str, mime_type: Option<&str>) -> Self {
                let raw = RawObject::new(
                    runtime,
                    BamlObjectType::$object_type,
                    (("url", url), ("mime_type", mime_type)),
                )
                .unwrap_or_else(|e| baml_unreachable!("Failed to create {} from URL: {}", stringify!($name), e));
                Self { raw }
            }

            /// Create from base64-encoded data
            pub fn from_base64(runtime: *const c_void, base64: &str, mime_type: Option<&str>) -> Self {
                let raw = RawObject::new(
                    runtime,
                    BamlObjectType::$object_type,
                    (("base64", base64), ("mime_type", mime_type)),
                )
                .unwrap_or_else(|e| baml_unreachable!("Failed to create {} from base64: {}", stringify!($name), e));
                Self { raw }
            }

            /// Get the MIME type (if known)
            pub fn mime_type(&self) -> Option<String> {
                self.raw.call_method("mime_type", ())
            }

            /// Check if this is a URL reference
            pub fn is_url(&self) -> bool {
                self.raw.call_method("is_url", ())
            }

            /// Check if this is base64 encoded
            pub fn is_base64(&self) -> bool {
                self.raw.call_method("is_base64", ())
            }

            /// Get as URL (if applicable)
            pub fn as_url(&self) -> Option<String> {
                self.raw.call_method("as_url", ())
            }

            /// Get as base64 (if applicable)
            pub fn as_base64(&self) -> Option<String> {
                self.raw.call_method("as_base64", ())
            }
        }

        impl std::fmt::Debug for $name {
            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                f.debug_struct(stringify!($name)).finish_non_exhaustive()
            }
        }

        impl Default for $name {
            fn default() -> Self {
                unreachable!("Media types cannot be default-constructed; they require a runtime")
            }
        }

        impl $crate::BamlDecode for $name {
            fn baml_decode(
                _holder: &$crate::__internal::CffiValueHolder
            ) -> ::core::result::Result<Self, $crate::BamlError> {
                // Media types come as ObjectValue which requires runtime context to decode.
                // This path shouldn't be hit in normal usage - media decoding goes through
                // the runtime's object handle mechanism instead.
                Err($crate::BamlError::internal(
                    concat!("Cannot decode ", stringify!($name), " without runtime context")
                ))
            }
        }
    };
}

// =============================================================================
// Media type definitions
// =============================================================================

define_media_type! {
    /// Image media type
    Image => ObjectMediaImage
}

define_media_type! {
    /// Audio media type
    Audio => ObjectMediaAudio
}

define_media_type! {
    /// PDF media type
    Pdf => ObjectMediaPdf
}

define_media_type! {
    /// Video media type
    Video => ObjectMediaVideo
}