Struct BamlRuntime 

pub struct BamlRuntime { /* private fields */ }

Handle to the BAML runtime

Implementations

impl BamlRuntime

pub fn new( baml_src_dir: &str, files: &HashMap<String, String>, env: &HashMap<String, String>, ) -> Result<Self, BamlError>

Create a new runtime from embedded BAML source files

Arguments

• baml_src_dir - Base directory path for BAML sources
• files - Map of relative file paths to file contents
• env - Environment variables

pub fn call_function<T: BamlDecode>( &self, name: &str, args: &FunctionArgs, ) -> Result<T, BamlError>

Call a function synchronously (blocks until complete)

pub fn call_function_stream<TPartial, TFinal>( &self, name: &str, args: &FunctionArgs, ) -> Result<StreamingCall<TPartial, TFinal>, BamlError>

where TPartial: BamlDecode + Send + 'static, TFinal: Clone + BamlDecode + Send + 'static,

Call a function with streaming results

pub async fn call_function_async<T: BamlDecode>( &self, name: &str, args: &FunctionArgs, ) -> Result<T, BamlError>

Call a function asynchronously (non-blocking)

pub fn call_function_stream_async<TPartial, TFinal>( &self, name: &str, args: &FunctionArgs, ) -> Result<AsyncStreamingCall<TPartial, TFinal>, BamlError>

where TPartial: BamlDecode + Send + 'static, TFinal: Clone + BamlDecode + Send + 'static,

Call a function with async streaming results

pub fn parse<T: BamlDecode>( &self, function_name: &str, llm_response: &str, stream: bool, ) -> Result<T, BamlError>

Parse raw LLM output into typed result

Given the name of a BAML function and the raw text response from an LLM, this method parses the response according to the function’s output type.

Arguments

• function_name - Name of the BAML function that defines the output type
• llm_response - Raw text response from the LLM

Example

let raw_response = "Hello, World!";
let result: String = runtime.parse("SayHello", raw_response)?;

pub fn new_image_from_url(&self, url: &str, mime_type: Option<&str>) -> Image

Create an Image from a URL

pub fn new_image_from_base64( &self, base64: &str, mime_type: Option<&str>, ) -> Image

Create an Image from base64-encoded data

pub fn new_audio_from_url(&self, url: &str, mime_type: Option<&str>) -> Audio

Create Audio from a URL

pub fn new_audio_from_base64( &self, base64: &str, mime_type: Option<&str>, ) -> Audio

Create Audio from base64-encoded data

pub fn new_pdf_from_url(&self, url: &str, mime_type: Option<&str>) -> Pdf

Create a PDF from a URL

pub fn new_pdf_from_base64(&self, base64: &str, mime_type: Option<&str>) -> Pdf

Create a PDF from base64-encoded data

pub fn new_video_from_url(&self, url: &str, mime_type: Option<&str>) -> Video

Create a Video from a URL

pub fn new_video_from_base64( &self, base64: &str, mime_type: Option<&str>, ) -> Video

Create a Video from base64-encoded data

pub fn new_collector(&self, name: &str) -> Collector

Create a new collector for telemetry

pub fn new_type_builder(&self) -> TypeBuilder

Create a new TypeBuilder for dynamic type construction

Trait Implementations

impl Drop for BamlRuntime

fn drop(&mut self)

Executes the destructor for this type.

impl Send for BamlRuntime

impl Sync for BamlRuntime