Ruby

Install BAML VSCode Extension

https://marketplace.visualstudio.com/items?itemName=boundary.baml-extension

• syntax highlighting
• testing playground
• prompt previews

Install BAML

$
bundle add baml sorbet-runtime

Add BAML to your existing project

This will give you some starter BAML code in a baml_src directory.

$
bundle exec baml-cli init

Generate Ruby code from .baml files

$
bundle exec baml-cli generate

` See What is baml_src to learn more about how this works.

As fun as writing BAML is, we want you be able to leverage BAML with existing ruby modules. This command gives you a ruby module that is a type-safe interface to every BAML function.

Use a BAML function in Ruby!

1
require_relative "baml_client/client"
2
3
def example(raw_resume)
4
    # r is an instance of Baml::Types::Resume, defined in baml_client/types
5
    r = Baml.Client.ExtractResume(resume: raw_resume)
6
7
    puts "ExtractResume response:"
8
    puts r.inspect
9
end
10
11
example 'Grace Hopper created COBOL'