agent-framework/python/samples/getting_started/azure_functions/03_callbacks

Callback Telemetry Sample

This sample demonstrates how to use the Durable Extension for Agent Framework's response callbacks to observe streaming updates and final agent responses in real time. The ConversationAuditTrail callback records each chunk received from the Azure OpenAI agent and exposes the collected events through an HTTP API that can be polled by a web client or dashboard.

Highlights

• Registers a default AgentResponseCallbackProtocol implementation that logs streaming and final responses.
• Persists callback events in an in-memory store and exposes them via GET /api/agents/{agentName}/callbacks/{thread_id}.
• Shows how to reset stored callback events with DELETE /api/agents/{agentName}/callbacks/{thread_id}.
• Works alongside the standard /api/agents/{agentName}/run endpoint so you can correlate callback telemetry with agent responses.

Prerequisites

Complete the shared environment setup steps in ../README.md, including creating a virtual environment, installing dependencies, and configuring Azure OpenAI credentials and storage settings.

Note: This is a streaming example that currently uses a local in-memory store for simplicity. For distributed environments, consider using Redis, Service Bus, or another pub/sub mechanism for callback coordination.

Running the Sample

Send a prompt to the agent:

curl -X POST http://localhost:7071/api/agents/CallbackAgent/run \
   -H "Content-Type: application/json" \
   -d '{"message": "Tell me a short joke"}'

Note: The run endpoint waits for the agent response by default. To return immediately, set the x-ms-wait-for-response header or include "wait_for_response": false in the request body.

Poll callback telemetry (replace <conversationId> with the value from the POST response):

curl http://localhost:7071/api/agents/CallbackAgent/callbacks/<conversationId>

Reset stored events:

curl -X DELETE http://localhost:7071/api/agents/CallbackAgent/callbacks/<conversationId>

Expected Output

When you call GET /api/agents/CallbackAgent/callbacks/{thread_id} after sending a request to the agent, the API returns a list of streaming and final callback events similar to the following:

[
  {
    "timestamp": "2024-01-01T00:00:00Z",
    "agent_name": "CallbackAgent",
    "thread_id": "<thread_id>",
    "correlation_id": "<guid>",
    "request_message": "Tell me a short joke",
    "event_type": "stream",
    "update_kind": "text",
    "text": "Sure, here's a joke..."
  },
  {
    "timestamp": "2024-01-01T00:00:01Z",
    "agent_name": "CallbackAgent",
    "thread_id": "<thread_id>",
    "correlation_id": "<guid>",
    "request_message": "Tell me a short joke",
    "event_type": "final",
    "response_text": "Why did the cloud...",
    "usage": {
      "type": "usage_details",
      "input_token_count": 159,
      "output_token_count": 29,
      "total_token_count": 188
    }
  }
]