Documentation

HomeBAMLCLICloudTutorialsExamples

BAML documentation

  • Overview
  • Get started
  • Book
    • 8. Handle errors
    • 11. Interfaces
    • 12. Run work concurrently
  • Language reference
    • Functions
  • Standard packages
  • Language bridges
    • TypeScript

Products

  • BAML CLI
  • Cloud

Resources

  • Tutorials
    • Structured extraction
  • Examples
    • Classify support tickets
HomeBAMLCLICloudTutorialsExamples
Start

Sections

  • Overview
  • Get started
  • Book
    • 8. Handle errors
    • 11. Interfaces
    • 12. Run work concurrently
  • Language reference
    • Functions
  • Standard packages
  • Language bridges
    • TypeScript

Products

  • BAML CLI
  • Cloud

Resources

  • Tutorials
    • Structured extraction
  • Examples
    • Classify support tickets
BAMLStandard packagesv0.19.0aievents

ai.events

namespace in the ai package.

Reference version

Contents

  • ai.events.AssistantMessage class
  • ai.events.AssistantMessage$stream class
  • ai.events.Event type_alias
  • ai.events.Event$stream type_alias
  • ai.events.FinalProduced class
  • ai.events.FinalProduced$stream class
  • ai.events.guard function
  • ai.events.HttpResponse class
  • ai.events.HttpResponse$stream class
  • ai.events.LLMCall class
  • ai.events.LLMCall$stream class
  • ai.events.RunStarted class
  • ai.events.RunStarted$stream class
  • ai.events.SseEventRecord class
  • ai.events.SseEventRecord$stream class
  • ai.events.Timing class
  • ai.events.Timing$stream class
  • ai.events.ToolCompleted class
  • ai.events.ToolCompleted$stream class
  • ai.events.ToolFailed class
  • ai.events.ToolFailed$stream class
  • ai.events.ToolRequested class
  • ai.events.ToolRequested$stream class
  • ai.events.Usage class
  • ai.events.Usage$stream class
  • ai.events.UserMessage class
  • ai.events.UserMessage$stream class

On this page

  • Contents

Build with BAML

Start with the language guide and a checked BAML function.

Continue into generated package and CLI references for the exact selected toolchain.

Get started
Developer documentation for BAML and Boundary products. Source available on GitHub. View release notes