@@dynamic — Boundary Documentation

The @@dynamic attribute in BAML allows for the dynamic modification of fields or values at runtime. This is particularly useful when you need to adapt the structure of your data models based on runtime conditions or external inputs.

Usage

Dynamic Classes

The @@dynamic attribute can be applied to classes, enabling the addition of fields dynamically during runtime.

BAML

1 class MyClass {
2   property1 string
3   property2 int?
4 
5   @@dynamic // allows adding fields dynamically at runtime
6 }

Dynamic Enums

Similarly, the @@dynamic attribute can be applied to enums, allowing for the modification of enum values at runtime.

BAML

1 enum MyEnum {
2   Value1
3   Value2
4 
5   @@dynamic // allows modifying enum values dynamically at runtime
6 }

Using `@@dynamic` with TypeBuilder

To modify dynamic types at runtime, you can use the TypeBuilder from the baml_client. Below are examples for Python, TypeScript, and Ruby.

Python Example

1 from baml_client.type_builder import TypeBuilder
2 from baml_client import b
3 
4 async def run():
5   tb = TypeBuilder()
6   tb.MyClass.add_property('email', tb.string())
7   tb.MyClass.add_property('address', tb.string()).description("The user's address")
8   res = await b.DynamicUserCreator("some user info", { "tb": tb })
9   # Now res can have email and address fields
10   print(res)

TypeScript Example

1 import TypeBuilder from '../baml_client/type_builder'
2 import { b } from '../baml_client'
3 
4 async function run() {
5   const tb = new TypeBuilder()
6   tb.MyClass.addProperty('email', tb.string())
7   tb.MyClass.addProperty('address', tb.string()).description("The user's address")
8   const res = await b.DynamicUserCreator("some user info", { tb: tb })
9   // Now res can have email and address fields
10   console.log(res)
11 }

Ruby Example

1 require_relative 'baml_client/client'
2 
3 def run
4   tb = Baml::TypeBuilder.new
5   tb.MyClass.add_property('email', tb.string)
6   tb.MyClass.add_property('address', tb.string).description("The user's address")
7   
8   res = Baml::Client.dynamic_user_creator(input: "some user info", baml_options: {tb: tb})
9   # Now res can have email and address fields
10   puts res
11 end

Testing Dynamic Types

Dynamic classes and enums can be modified in tests using the type_builder and dynamic blocks. All properties added in the dynamic block will be available during the test execution.

1 class DynamicClass {
2     static_prop string
3     @@dynamic
4 }
5 
6 function ReturnDynamicClass(input: string) -> DynamicClass {
7     // ...
8 }
9 
10 test DynamicClassTest {
11     functions [ReturnDynamicClass]
12     type_builder {
13         dynamic DynamicClass {
14             new_prop_here string
15         }
16     }
17     args {
18         input "test data"
19     }
20 }

1	class MyClass {
2	property1 string
3	property2 int?
4
5	@@dynamic // allows adding fields dynamically at runtime
6	}

1	enum MyEnum {
2	Value1
3	Value2
4
5	@@dynamic // allows modifying enum values dynamically at runtime
6	}

1	from baml_client.type_builder import TypeBuilder
2	from baml_client import b
3
4	async def run():
5	tb = TypeBuilder()
6	tb.MyClass.add_property('email', tb.string())
7	tb.MyClass.add_property('address', tb.string()).description("The user's address")
8	res = await b.DynamicUserCreator("some user info", { "tb": tb })
9	# Now res can have email and address fields
10	print(res)

1	import TypeBuilder from '../baml_client/type_builder'
2	import { b } from '../baml_client'
3
4	async function run() {
5	const tb = new TypeBuilder()
6	tb.MyClass.addProperty('email', tb.string())
7	tb.MyClass.addProperty('address', tb.string()).description("The user's address")
8	const res = await b.DynamicUserCreator("some user info", { tb: tb })
9	// Now res can have email and address fields
10	console.log(res)
11	}

1	require_relative 'baml_client/client'
2
3	def run
4	tb = Baml::TypeBuilder.new
5	tb.MyClass.add_property('email', tb.string)
6	tb.MyClass.add_property('address', tb.string).description("The user's address")
7
8	res = Baml::Client.dynamic_user_creator(input: "some user info", baml_options: {tb: tb})
9	# Now res can have email and address fields
10	puts res
11	end

1	class DynamicClass {
2	static_prop string
3	@@dynamic
4	}
5
6	function ReturnDynamicClass(input: string) -> DynamicClass {
7	// ...
8	}
9
10	test DynamicClassTest {
11	functions [ReturnDynamicClass]
12	type_builder {
13	dynamic DynamicClass {
14	new_prop_here string
15	}
16	}
17	args {
18	input "test data"
19	}
20	}