callbacks

{{ $frontmatter.title }}

ActiveAgent provides callbacks for four different lifecycles:

• Generation callbacks (before_generation, after_generation, around_generation) - Wrap both prompting and embedding operations for rate limiting, authentication, and logging
• Prompting callbacks (before_prompt, after_prompt, around_prompt) - Specific to prompt execution
• Embedding callbacks (before_embed, after_embed, around_embed) - Specific to embedding operations
• Streaming callbacks (on_stream_open, on_stream, on_stream_close) - Handle real-time streaming responses as they arrive

Use generation callbacks for cross-cutting concerns, prompting/embedding callbacks for operation-specific behavior, and streaming callbacks for processing responses in real-time.

Generation Callbacks

Generation callbacks wrap both prompting and embedding operations for rate limiting, authentication, and resource management.

Before Generation

Runs before any generation executes. Use for setup, rate limiting, or validation:

<<< @/../test/docs/agents/callbacks_examples_test.rb#before_generation {ruby:line-numbers}

After Generation

Runs after any generation completes. Use for logging, usage tracking, or cleanup:

<<< @/../test/docs/agents/callbacks_examples_test.rb#after_generation {ruby:line-numbers}

After callbacks are skipped if the callback chain is terminated with throw :abort.

Around Generation

Wraps the entire generation process. Use for timing, transactions, or resource management:

<<< @/../test/docs/agents/callbacks_examples_test.rb#around_generation {ruby:line-numbers}

Rate Limiting Example

<<< @/../test/docs/agents/callbacks_examples_test.rb#rate_limiting {ruby:line-numbers}

Prompting Callbacks

Prompting callbacks are specific to prompt execution:

<<< @/../test/docs/agents/callbacks_examples_test.rb#prompting_callbacks {ruby:line-numbers}

Embedding Callbacks

Embedding callbacks are specific to embedding operations: