Skip to navigation
Attributes

@skip

The @skip attribute in BAML is used to exclude certain fields or values from being included in prompts or parsed responses. This can be useful when certain data is not relevant for the LLM’s processing.

In the case of class fields, the field type must be nullable if @skip is used in order to allow parsing LLM responses that will not include the field.

This is valid:

OK
class MyClass {
  field1 string
  field2 string? @skip // OK because field2 is nullable
}

This is not:

NOT OK
class MyClass {
  field1 string
  field2 string @skip // Error: Field with @skip attribute must be optional.
}

Prompt Impact

Without @skip

BAML
enum MyEnum {
  Value1
  Value2
}
class MyClass {
  field1 string
  field2 string?
}

ctx.output_format:

  • MyEnum
MyEnum
---
Value1
Value2
  • MyClass
{
  field1: string,
  field2: string or null,
}

With @skip

BAML
enum MyEnum {
  Value1
  Value2 @skip
}
class MyClass {
  field1 string
  field2 string? @skip
}

ctx.output_format:

  • MyEnum
MyEnum
---
Value1
  • MyClass
{
  field1: string,
}