ringo-fm 0.1.0

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

//! `Generable` — types the model can produce via structured generation.
//!
//! V1 ships the trait only; an automatic `#[derive(Generable)]` proc macro is a
//! follow-up. Implement manually:
//!
//! ```ignore
//! use ringo_fm::{Generable, GenerationSchema, GenerationSchemaProperty, GeneratedContent, Result};
//!
//! struct Person { name: String, age: i32 }
//!
//! impl Generable for Person {
//!     fn schema() -> Result<GenerationSchema> {
//!         let mut s = GenerationSchema::new("Person", None)?;
//!         s.add_property(GenerationSchemaProperty::new("name", None, "String", false)?);
//!         s.add_property(GenerationSchemaProperty::new("age",  None, "Int",    false)?);
//!         Ok(s)
//!     }
//!     fn from_generated(content: &GeneratedContent) -> Result<Self> {
//!         Ok(Person {
//!             name: content.get_property("name")?,
//!             age: content.get_property("age")?.parse().map_err(|e| ringo_fm::Error::Native(format!("{e}")))?,
//!         })
//!     }
//! }
//! ```

use crate::error::Result;
use crate::generated::GeneratedContent;
use crate::schema::GenerationSchema;

pub trait Generable: Sized {
    fn schema() -> Result<GenerationSchema>;
    fn from_generated(content: &GeneratedContent) -> Result<Self>;
}