ringo-fm 0.1.1

Idiomatic Rust bindings for Apple's on-device Foundation Models framework
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

//! `GenerationSchema` builder over `FMGenerationSchema*` C calls.

use std::ffi::{c_void, CString};

use ringo_fm_sys as sys;

use crate::error::{Error, Result};
use crate::handle::{check_error, FmString, ManagedRef};

pub(crate) struct SchemaTag;
pub(crate) struct SchemaPropertyTag;

/// Constraint applied to a [`GenerationSchemaProperty`].
///
/// Use the constructor methods (`any_of`, `constant`, `count`, `element`, …)
/// rather than constructing variants directly. `element(inner)` wraps another
/// guide so the constraint applies to each element of an array property.
#[derive(Debug, Clone)]
pub enum GenerationGuide {
    /// One of a fixed set of values.
    AnyOf { choices: Vec<String>, wrapped: bool },
    /// Exact element count (array properties).
    Count { count: i32, wrapped: bool },
    Maximum { value: f64, wrapped: bool },
    Minimum { value: f64, wrapped: bool },
    Range { min: f64, max: f64, wrapped: bool },
    Regex { pattern: String, wrapped: bool },
    MinItems(i32),
    MaxItems(i32),
}

impl GenerationGuide {
    /// Constrains the property to one of the given values.
    pub fn any_of(choices: impl IntoIterator<Item = impl Into<String>>) -> Self {
        Self::AnyOf { choices: choices.into_iter().map(Into::into).collect(), wrapped: false }
    }

    /// Constrains the property to a single fixed value.
    pub fn constant(value: impl Into<String>) -> Self {
        Self::AnyOf { choices: vec![value.into()], wrapped: false }
    }

    /// Wraps another guide so the constraint applies to each element of an
    /// array property rather than the array itself. Mirrors Go's `Element(inner)`.
    pub fn element(inner: GenerationGuide) -> Self {
        let wrapped = inner.into_wrapped();
        wrapped
    }

    /// Exact element count for an array property.
    pub fn count(n: i32) -> Self { Self::Count { count: n, wrapped: false } }

    pub fn maximum(v: f64) -> Self { Self::Maximum { value: v, wrapped: false } }
    pub fn minimum(v: f64) -> Self { Self::Minimum { value: v, wrapped: false } }
    pub fn range(min: f64, max: f64) -> Self { Self::Range { min, max, wrapped: false } }
    pub fn regex(pattern: impl Into<String>) -> Self {
        Self::Regex { pattern: pattern.into(), wrapped: false }
    }
    pub fn min_items(n: i32) -> Self { Self::MinItems(n) }
    pub fn max_items(n: i32) -> Self { Self::MaxItems(n) }

    /// Converts this guide into its `wrapped=true` form for use inside an array element.
    fn into_wrapped(self) -> Self {
        match self {
            Self::AnyOf { choices, .. } => Self::AnyOf { choices, wrapped: true },
            Self::Count { count, .. } => Self::Count { count, wrapped: true },
            Self::Maximum { value, .. } => Self::Maximum { value, wrapped: true },
            Self::Minimum { value, .. } => Self::Minimum { value, wrapped: true },
            Self::Range { min, max, .. } => Self::Range { min, max, wrapped: true },
            Self::Regex { pattern, .. } => Self::Regex { pattern, wrapped: true },
            other => other,
        }
    }
}

/// One property of a [`GenerationSchema`].
pub struct GenerationSchemaProperty {
    pub(crate) handle: ManagedRef<SchemaPropertyTag>,
}

impl GenerationSchemaProperty {
    pub fn new(
        name: &str,
        description: Option<&str>,
        type_name: &str,
        is_optional: bool,
    ) -> Result<Self> {
        let name_c = CString::new(name).map_err(|e| Error::Native(e.to_string()))?;
        let type_c = CString::new(type_name).map_err(|e| Error::Native(e.to_string()))?;
        let desc_c = match description {
            Some(d) => Some(CString::new(d).map_err(|e| Error::Native(e.to_string()))?),
            None => None,
        };
        let desc_ptr = desc_c.as_ref().map_or(std::ptr::null(), |c| c.as_ptr());
        let ptr = unsafe {
            sys::FMGenerationSchemaPropertyCreate(name_c.as_ptr(), desc_ptr, type_c.as_ptr(), is_optional)
        };
        Ok(Self { handle: ManagedRef::from_owned(ptr)? })
    }

    pub fn add_guide(self, guide: &GenerationGuide) -> Result<Self> {
        let p = self.handle.as_ptr();
        match guide {
            GenerationGuide::AnyOf { choices, wrapped } => {
                let cstrs: Vec<CString> = choices
                    .iter()
                    .map(|s| CString::new(s.as_str()).map_err(|e| Error::Native(e.to_string())))
                    .collect::<Result<_>>()?;
                let ptrs: Vec<*const i8> = cstrs.iter().map(|c| c.as_ptr()).collect();
                unsafe {
                    sys::FMGenerationSchemaPropertyAddAnyOfGuide(
                        p,
                        ptrs.as_ptr() as *mut _,
                        ptrs.len() as i32,
                        *wrapped,
                    )
                };
            }
            GenerationGuide::Count { count, wrapped } => unsafe {
                sys::FMGenerationSchemaPropertyAddCountGuide(p, *count, *wrapped);
            },
            GenerationGuide::Maximum { value, wrapped } => unsafe {
                sys::FMGenerationSchemaPropertyAddMaximumGuide(p, *value, *wrapped);
            },
            GenerationGuide::Minimum { value, wrapped } => unsafe {
                sys::FMGenerationSchemaPropertyAddMinimumGuide(p, *value, *wrapped);
            },
            GenerationGuide::Range { min, max, wrapped } => unsafe {
                sys::FMGenerationSchemaPropertyAddRangeGuide(p, *min, *max, *wrapped);
            },
            GenerationGuide::Regex { pattern, wrapped } => {
                let pat_c = CString::new(pattern.as_str()).map_err(|e| Error::Native(e.to_string()))?;
                unsafe { sys::FMGenerationSchemaPropertyAddRegex(p, pat_c.as_ptr(), *wrapped) };
            }
            GenerationGuide::MinItems(n) => unsafe {
                sys::FMGenerationSchemaPropertyAddMinItemsGuide(p, *n);
            },
            GenerationGuide::MaxItems(n) => unsafe {
                sys::FMGenerationSchemaPropertyAddMaxItemsGuide(p, *n);
            },
        }
        Ok(self)
    }
}

/// Structured-generation schema.
pub struct GenerationSchema {
    pub(crate) handle: ManagedRef<SchemaTag>,
}

impl GenerationSchema {
    pub fn new(name: &str, description: Option<&str>) -> Result<Self> {
        let name_c = CString::new(name).map_err(|e| Error::Native(e.to_string()))?;
        let desc_c = match description {
            Some(d) => Some(CString::new(d).map_err(|e| Error::Native(e.to_string()))?),
            None => None,
        };
        let desc_ptr = desc_c.as_ref().map_or(std::ptr::null(), |c| c.as_ptr());
        let ptr = unsafe { sys::FMGenerationSchemaCreate(name_c.as_ptr(), desc_ptr) };
        Ok(Self { handle: ManagedRef::from_owned(ptr)? })
    }

    pub fn add_property(&mut self, prop: GenerationSchemaProperty) -> &mut Self {
        unsafe { sys::FMGenerationSchemaAddProperty(self.handle.as_ptr(), prop.handle.as_ptr()) };
        self
    }

    pub fn add_reference_schema(&mut self, other: &GenerationSchema) -> &mut Self {
        unsafe {
            sys::FMGenerationSchemaAddReferenceSchema(self.handle.as_ptr(), other.handle.as_ptr())
        };
        self
    }

    pub fn to_json(&self) -> Result<String> {
        let mut code: i32 = 0;
        let mut desc: *mut i8 = std::ptr::null_mut();
        let ptr = unsafe { sys::FMGenerationSchemaGetJSONString(self.handle.as_ptr(), &mut code, &mut desc) };
        check_error(code, desc)?;
        FmString::from_raw(ptr)
            .ok_or_else(|| Error::Native("schema JSON null".into()))?
            .to_string()
    }

    pub(crate) fn as_ptr(&self) -> *const c_void {
        self.handle.as_ptr()
    }
}