Callbacks

Callbacks no ADK-Rust fornecem ganchos para observar, personalizar e controlar o comportamento do agent em pontos de execução chave. Eles permitem logging, guardrails, caching, modificação de resposta e muito mais.

Visão Geral

ADK-Rust suporta seis tipos de callback que interceptam diferentes estágios da execução do agent:

Tipo de CallbackQuando ExecutadoCasos de Uso
before_agentAntes do agent iniciar o processamentoValidação de entrada, logging, terminação antecipada
after_agentDepois que o agent é concluídoModificação de resposta, logging, limpeza
before_modelAntes da chamada LLMModificação de requisição, caching, limitação de taxa
after_modelApós a resposta LLMFiltragem de resposta, logging, caching
before_toolAntes da execução da toolVerificações de permissão, validação de parâmetro
after_toolApós a execução da toolModificação de resultado, logging

Tipos de Callback

Callbacks de Agent

Callbacks de agent envolvem todo o ciclo de execução do agent.

use adk_rust::prelude::*;
use std::sync::Arc;

// Assinatura do tipo BeforeAgentCallback
type BeforeAgentCallback = Box<
    dyn Fn(Arc<dyn CallbackContext>) 
        -> Pin<Box<dyn Future<Output = Result<Option<Content>>> + Send>> 
    + Send + Sync
>;

// Assinatura do tipo AfterAgentCallback  
type AfterAgentCallback = Box<
    dyn Fn(Arc<dyn CallbackContext>) 
        -> Pin<Box<dyn Future<Output = Result<Option<Content>>> + Send>> 
    + Send + Sync
>;

Callbacks de Model

Callbacks de model interceptam requisições e respostas LLM.

use adk_rust::prelude::*;
use std::sync::Arc;

// BeforeModelResult - controla o que acontece após o callback
pub enum BeforeModelResult {
    Continue(LlmRequest),  // Continua com a requisição (possivelmente modificada)
    Skip(LlmResponse),     // Pula a chamada ao model, usa esta resposta em vez disso
}

// BeforeModelCallback - pode modificar a requisição ou pular a chamada ao model
type BeforeModelCallback = Box<
    dyn Fn(Arc<dyn CallbackContext>, LlmRequest)
        -> Pin<Box<dyn Future<Output = Result<BeforeModelResult>> + Send>>
    + Send + Sync
>;

// AfterModelCallback - pode modificar a resposta
type AfterModelCallback = Box<
    dyn Fn(Arc<dyn CallbackContext>, LlmResponse)
        -> Pin<Box<dyn Future<Output = Result<Option<LlmResponse>>> + Send>>
    + Send + Sync
>;

Callbacks de Tool

Callbacks de tool interceptam a execução da tool.

use adk_rust::prelude::*;
use std::sync::Arc;

// BeforeToolCallback - pode pular a tool retornando Some(Content)
type BeforeToolCallback = Box<
    dyn Fn(Arc<dyn CallbackContext>) 
        -> Pin<Box<dyn Future<Output = Result<Option<Content>>> + Send>> 
    + Send + Sync
>;

// AfterToolCallback - pode modificar o resultado da tool
type AfterToolCallback = Box<
    dyn Fn(Arc<dyn CallbackContext>) 
        -> Pin<Box<dyn Future<Output = Result<Option<Content>>> + Send>> 
    + Send + Sync
>;

Semântica dos Valores de Retorno

Callbacks usam diferentes valores de retorno para controlar o fluxo de execução:

Callbacks de Agent/Tool

Valor de RetornoEfeito
Ok(None)Continua a execução normal
Ok(Some(content))Substitui/ignora com o conteúdo fornecido
Err(e)Aborta a execução com erro

Callbacks de Modelo

BeforeModelCallback usa BeforeModelResult:

Valor de RetornoEfeito
Ok(BeforeModelResult::Continue(request))Continua com a requisição (possivelmente modificada)
Ok(BeforeModelResult::Skip(response))Ignora a chamada do modelo, usa esta resposta em vez disso
Err(e)Aborta a execução com erro

AfterModelCallback usa Option<LlmResponse>:

Valor de RetornoEfeito
Ok(None)Mantém a resposta original
Ok(Some(response))Substitui pela resposta modificada
Err(e)Aborta a execução com erro

Resumo

  • Callbacks antes de agent/tool: Retorne None para continuar, Some(content) para ignorar
  • Callback antes do modelo: Retorne Continue(request) para prosseguir, Skip(response) para ignorar o modelo
  • Callbacks depois: Retorne None para manter o original, Some(...) para substituir

Adicionando Callbacks a Agents

Callbacks são adicionados a agents usando o LlmAgentBuilder:

use adk_rust::prelude::*;
use std::sync::Arc;

#[tokio::main]
async fn main() -> std::result::Result<(), Box<dyn std::error::Error>> {
    let api_key = std::env::var("GOOGLE_API_KEY")?;
    let model = Arc::new(GeminiModel::new(&api_key, "gemini-2.5-flash")?);

    let agent = LlmAgentBuilder::new("my_agent")
        .model(model)
        .instruction("You are a helpful assistant.")
        // Adiciona callback before_agent
        .before_callback(Box::new(|ctx| {
            Box::pin(async move {
                println!("Agent starting: {}", ctx.agent_name());
                Ok(None) // Continua a execução
            })
        }))
        // Adiciona callback after_agent
        .after_callback(Box::new(|ctx| {
            Box::pin(async move {
                println!("Agent completed: {}", ctx.agent_name());
                Ok(None) // Mantém o resultado original
            })
        }))
        .build()?;

    Ok(())
}

Interface CallbackContext

A trait CallbackContext fornece acesso ao contexto de execução:

use adk_rust::prelude::*;

#[async_trait]
pub trait CallbackContext: ReadonlyContext {
    /// Acessa o armazenamento de artefatos (se configurado)
    fn artifacts(&self) -> Option<Arc<dyn Artifacts>>;
}

// CallbackContext estende ReadonlyContext
#[async_trait]
pub trait ReadonlyContext: Send + Sync {
    /// ID da invocação atual
    fn invocation_id(&self) -> &str;
    
    /// Nome do agent atual
    fn agent_name(&self) -> &str;
    
    /// ID do usuário da sessão
    fn user_id(&self) -> &str;
    
    /// Nome da aplicação
    fn app_name(&self) -> &str;
    
    /// ID da sessão
    fn session_id(&self) -> &str;
    
    /// Branch atual (para multi-agent)
    fn branch(&self) -> &str;
    
    /// O conteúdo de entrada do usuário
    fn user_content(&self) -> &Content;
}

Padrões Comuns

Callback de Registro de Logs

Registrar todas as interações do agent:

use adk_rust::prelude::*;
use std::sync::Arc;

let agent = LlmAgentBuilder::new("logged_agent")
    .model(model)
    .before_callback(Box::new(|ctx| {
        Box::pin(async move {
            println!("[LOG] Agent '{}' starting", ctx.agent_name());
            println!("[LOG] Session: {}", ctx.session_id());
            println!("[LOG] User: {}", ctx.user_id());
            Ok(None)
        })
    }))
    .after_callback(Box::new(|ctx| {
        Box::pin(async move {
            println!("[LOG] Agent '{}' completed", ctx.agent_name());
            Ok(None)
        })
    }))
    .build()?;

Guardrails de Entrada

Bloquear conteúdo inapropriado antes do processamento:

use adk_rust::prelude::*;
use std::sync::Arc;

let agent = LlmAgentBuilder::new("guarded_agent")
    .model(model)
    .before_callback(Box::new(|ctx| {
        Box::pin(async move {
            // Check user input for blocked content
            let user_content = ctx.user_content();
            for part in &user_content.parts {
                if let Part::Text { text } = part {
                    if text.to_lowercase().contains("blocked_word") {
                        // Return early with rejection message
                        return Ok(Some(Content {
                            role: "model".to_string(),
                            parts: vec![Part::Text {
                                text: "I cannot process that request.".to_string(),
                            }],
                        }));
                    }
                }
            }
            Ok(None) // Continue normal execution
        })
    }))
    .build()?;

Cache de Respostas (Antes do Modelo)

Armazenar em cache as respostas do LLM para reduzir chamadas de API:

use adk_rust::prelude::*;
use std::sync::Arc;
use std::collections::HashMap;
use std::sync::Mutex;

// Simple in-memory cache
let cache: Arc<Mutex<HashMap<String, LlmResponse>>> = Arc::new(Mutex::new(HashMap::new()));
let cache_clone = cache.clone();

let agent = LlmAgentBuilder::new("cached_agent")
    .model(model)
    .before_model_callback(Box::new(move |ctx, request| {
        let cache = cache_clone.clone();
        Box::pin(async move {
            // Create cache key from request contents
            let key = format!("{:?}", request.contents);

            // Check cache
            if let Some(cached) = cache.lock().unwrap().get(&key) {
                println!("[CACHE] Hit for request");
                return Ok(BeforeModelResult::Skip(cached.clone()));
            }

            println!("[CACHE] Miss, calling model");
            Ok(BeforeModelResult::Continue(request)) // Continue to model
        })
    }))
    .build()?;

Injetando Conteúdo Multimodal (Antes do Modelo)

Injetar imagens ou outro conteúdo binário nas requisições do LLM para análise multimodal:

use adk_rust::prelude::*;
use adk_rust::artifact::{ArtifactService, LoadRequest};
use std::sync::Arc;

// Artifact service with pre-loaded image
let artifact_service: Arc<dyn ArtifactService> = /* ... */;
let callback_service = artifact_service.clone();

let agent = LlmAgentBuilder::new("image_analyst")
    .model(model)
    .instruction("Describe the image provided by the user.")
    .before_model_callback(Box::new(move |_ctx, mut request| {
        let service = callback_service.clone();
        Box::pin(async move {
            // Load image from artifact storage
            if let Ok(response) = service.load(LoadRequest {
                app_name: "my_app".to_string(),
                user_id: "user".to_string(),
                session_id: "session".to_string(),
                file_name: "user:photo.png".to_string(),
                version: None,
            }).await {
                // Inject image into the user's message
                if let Some(last_content) = request.contents.last_mut() {
                    if last_content.role == "user" {
                        last_content.parts.push(response.part);
                    }
                }
            }

            Ok(BeforeModelResult::Continue(request))
        })
    }))
    .build()?;

Este padrão é essencial para IA multimodal porque as respostas das tools são texto JSON - o modelo não consegue "ver" imagens retornadas pelas tools. Ao injetar a imagem diretamente na requisição, o modelo recebe dados de imagem reais.

Modificação de Resposta (Após o Modelo)

Modificar ou filtrar respostas do modelo:

use adk_rust::prelude::*;
use std::sync::Arc;

let agent = LlmAgentBuilder::new("filtered_agent")
    .model(model)
    .after_model_callback(Box::new(|ctx, mut response| {
        Box::pin(async move {
            // Modify the response content
            if let Some(ref mut content) = response.content {
                for part in &mut content.parts {
                    if let Part::Text { text } = part {
                        // Add disclaimer to all responses
                        *text = format!("{}\n\n[AI-generated response]", text);
                    }
                }
            }
            Ok(Some(response))
        })
    }))
    .build()?;

Verificação de Permissão de Tool (Antes da Tool)

Validar permissões de execução da tool:

use adk_rust::prelude::*;
use std::sync::Arc;

let agent = LlmAgentBuilder::new("permission_agent")
    .model(model)
    .tool(Arc::new(GoogleSearchTool::new()))
    .before_tool_callback(Box::new(|ctx| {
        Box::pin(async move {
            // Check if user has permission for tools
            let user_id = ctx.user_id();
            
            // Example: block certain users from using tools
            if user_id == "restricted_user" {
                return Ok(Some(Content {
                    role: "function".to_string(),
                    parts: vec![Part::Text {
                        text: "Tool access denied for this user.".to_string(),
                    }],
                }));
            }
            
            Ok(None) // Allow tool execution
        })
    }))
    .build()?;

Registro de Log de Resultado da Tool (Após a Tool)

Registrar todas as execuções de tool:

use adk_rust::prelude::*;
use std::sync::Arc;

let agent = LlmAgentBuilder::new("tool_logged_agent")
    .model(model)
    .tool(Arc::new(GoogleSearchTool::new()))
    .after_tool_callback(Box::new(|ctx| {
        Box::pin(async move {
            println!("[TOOL LOG] Tool executed for agent: {}", ctx.agent_name());
            println!("[TOOL LOG] Session: {}", ctx.session_id());
            Ok(None) // Keep original result
        })
    }))
    .build()?;

Múltiplos Callbacks

Você pode adicionar múltiplos callbacks do mesmo tipo. Eles são executados em ordem:

use adk_rust::prelude::*;
use std::sync::Arc;

let agent = LlmAgentBuilder::new("multi_callback_agent")
    .model(model)
    // First before callback - logging
    .before_callback(Box::new(|ctx| {
        Box::pin(async move {
            println!("[1] Logging callback");
            Ok(None)
        })
    }))
    // Second before callback - validation
    .before_callback(Box::new(|ctx| {
        Box::pin(async move {
            println!("[2] Validation callback");
            Ok(None)
        })
    }))
    .build()?;

Quando um callback retorna Some(content), callbacks subsequentes do mesmo tipo são ignorados.

Tratamento de Erros

Callbacks podem retornar erros para abortar a execução:

use adk_rust::prelude::*;
use std::sync::Arc;

let agent = LlmAgentBuilder::new("error_handling_agent")
    .model(model)
    .before_callback(Box::new(|ctx| {
        Box::pin(async move {
            // Validate something critical
            if ctx.user_id().is_empty() {
                return Err(AdkError::Agent("User ID is required".to_string()));
            }
            Ok(None)
        })
    }))
    .build()?;

Melhores Práticas

  1. Mantenha os callbacks leves: Evite computação pesada em callbacks
  2. Trate os erros de forma elegante: Retorne mensagens de erro significativas
  3. Use o registro (logging) com moderação: O excesso de registro pode afetar o desempenho
  4. Use cache com sabedoria: Considere estratégias de invalidação de cache
  5. Teste os callbacks independentemente: Faça testes de unidade da lógica do callback separadamente

Relacionado


Anterior: ← State Management | Próximo: Artifacts →