google--adk-python/contributing/workflow_samples/message

ADK Workflow Message Sample

Overview

This sample demonstrates different ways to send a message to a user using Event(message=...) within an ADK Workflows node. It covers:

1. String Messages: Standard string text replies.
2. Multi-modal Messages: Returning mixed modality inputs, such as a string combined with an inline image.
3. Multiple Messages: Emitting multiple full messages from the same node with a delay between them.

Sample Inputs

This workflow executes sequentially and successfully without any expected user input. Since it has only one Workflow node chain that automatically progresses from START, you can just type anything (e.g. start) to kick it off.

Graph

                  [ START ]
                      |
                      v
               [ send_string ]
                      |
                      v
             [ send_multimodal ]
                      |
                      v
            [ multiple_messages ]
                      |
                      v
                 (Workflow Ends)

How To

To send messages in an ADK node, yield an Event object with the message argument:

1. Send a simple string:

   yield Event(message="Hello world!")
   

2. Send text with an image (multi-modal):

   from google.genai import types
   yield Event(
       message=[
           types.Part.from_text(text="Look at this image:"),
           types.Part.from_bytes(data=image_bytes, mime_type="image/png"),
       ]
   )
   

3. Send multiple messages: To send multiple distinct messages from a single node, yield multiple Event objects sequentially.

   Note

   : When yielding multiple messages with delays (await asyncio.sleep(...)), your node function must be an asynchronous generator (async def). This allows ADK to yield each message to the client immediately without blocking.

   import asyncio
   
   async def multiple_messages(node_input: Any = None):
     yield Event(message="Processing step 1...")
     await asyncio.sleep(1.0)
   
     yield Event(message="Processing step 2...")
     await asyncio.sleep(1.0)
   
     yield Event(message="Done processing.")