Skip to content

A programming framework for agentic AI

human-in-the-loop section for agentchat tutorial (#4832)

Eric Zhub9bd8b0c64db
diff --git a/python/packages/autogen-agentchat/src/autogen_agentchat/agents/_user_proxy_agent.py b/python/packages/autogen-agentchat/src/autogen_agentchat/agents/_user_proxy_agent.py
index 6b8ab3055..1695be426 100644
--- a/python/packages/autogen-agentchat/src/autogen_agentchat/agents/_user_proxy_agent.py
+++ b/python/packages/autogen-agentchat/src/autogen_agentchat/agents/_user_proxy_agent.py
@@ -48,7 +48,7 @@ class UserProxyAgent(BaseChatAgent):
You can run the team again with the user input. This way, the state of the team
can be saved and restored when the user responds.
- See `Pause for User Input <https://microsoft.github.io/autogen/dev/user-guide/agentchat-user-guide/tutorial/teams.html#pause-for-user-input>`_ for more information.
+ See `Human-in-the-loop <https://microsoft.github.io/autogen/dev/user-guide/agentchat-user-guide/tutorial/human-in-the-loop.html>`_ for more information.
Example:
Simple usage case::
diff --git a/python/packages/autogen-core/docs/drawio/human-in-the-loop-termination.drawio b/python/packages/autogen-core/docs/drawio/human-in-the-loop-termination.drawio
new file mode 100644
index 000000000..1c4b1564b
--- /dev/null
+++ b/python/packages/autogen-core/docs/drawio/human-in-the-loop-termination.drawio
@@ -0,0 +1,64 @@
+<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36 Edg/131.0.0.0" version="24.8.9">
+ <diagram id="W6FvA7JMSRd8l6w4kv95" name="Page-1">
+ <mxGraphModel dx="1645" dy="1089" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+ <root>
+ <mxCell id="0" />
+ <mxCell id="1" parent="0" />
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-1" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.25;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;fontStyle=0;strokeWidth=2;" parent="1" source="sYyRPZP6EHBJkb5ZCHJR-2" target="sYyRPZP6EHBJkb5ZCHJR-12" edge="1">
+ <mxGeometry relative="1" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-2" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#f5f5f5;strokeColor=#666666;fontColor=#333333;" parent="1" vertex="1">
+ <mxGeometry x="250" y="450" width="300" height="260" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.25;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="sYyRPZP6EHBJkb5ZCHJR-6" target="sYyRPZP6EHBJkb5ZCHJR-8" edge="1">
+ <mxGeometry relative="1" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="sYyRPZP6EHBJkb5ZCHJR-6" target="sYyRPZP6EHBJkb5ZCHJR-7" edge="1">
+ <mxGeometry relative="1" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-5" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.75;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="sYyRPZP6EHBJkb5ZCHJR-6" target="sYyRPZP6EHBJkb5ZCHJR-9" edge="1">
+ <mxGeometry relative="1" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-6" value="" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;verticalAlign=middle;" parent="1" vertex="1">
+ <mxGeometry x="280" y="520" width="100" height="120" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-7" value="Agent 2" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
+ <mxGeometry x="420" y="550" width="100" height="60" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-8" value="Agent 1" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
+ <mxGeometry x="420" y="470" width="100" height="60" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-9" value="&lt;div&gt;Agent 3&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
+ <mxGeometry x="420" y="630" width="100" height="60" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-10" value="RoundRobinGroupChat" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
+ <mxGeometry x="255" y="460" width="150" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-11" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0.25;entryY=0;entryDx=0;entryDy=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;fontStyle=0;strokeWidth=2;" parent="1" source="sYyRPZP6EHBJkb5ZCHJR-12" target="sYyRPZP6EHBJkb5ZCHJR-2" edge="1">
+ <mxGeometry relative="1" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-12" value="Application/User" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
+ <mxGeometry x="70" y="540" width="120" height="80" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-13" value="Task/Feedback" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1" parent="1" vertex="1">
+ <mxGeometry x="40" y="500" width="90" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-14" value="TaskResult" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1" parent="1" vertex="1">
+ <mxGeometry x="60" y="650" width="60" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-15" value="&lt;b&gt;Termination&lt;/b&gt;&lt;div&gt;&lt;b&gt;Condition&lt;/b&gt;&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" parent="1" vertex="1">
+ <mxGeometry x="285" y="580" width="90" height="50" as="geometry" />
+ </mxCell>
+ <mxCell id="sYyRPZP6EHBJkb5ZCHJR-16" value="&lt;span style=&quot;text-wrap-mode: wrap;&quot;&gt;Orchestrator&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
+ <mxGeometry x="285" y="530" width="90" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="dF9Xe1aUO8W1j2Y2Youd-1" value="Starts / Resumes the Team" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1" vertex="1" parent="1">
+ <mxGeometry x="150" y="400" width="160" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="dF9Xe1aUO8W1j2Y2Youd-2" value="Saves the Team&#39;s State" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontStyle=1" vertex="1" parent="1">
+ <mxGeometry x="162.5" y="730" width="135" height="30" as="geometry" />
+ </mxCell>
+ </root>
+ </mxGraphModel>
+ </diagram>
+</mxfile>
diff --git a/python/packages/autogen-core/docs/drawio/human-in-the-loop-user-proxy.drawio b/python/packages/autogen-core/docs/drawio/human-in-the-loop-user-proxy.drawio
new file mode 100644
index 000000000..6b392341e
--- /dev/null
+++ b/python/packages/autogen-core/docs/drawio/human-in-the-loop-user-proxy.drawio
@@ -0,0 +1,92 @@
+<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36 Edg/131.0.0.0" version="24.8.9">
+ <diagram id="-WALZMLRurTB1BmUSyM2" name="Page-1">
+ <mxGraphModel dx="1645" dy="1089" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+ <root>
+ <mxCell id="0" />
+ <mxCell id="1" parent="0" />
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-22" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.25;exitY=1;exitDx=0;exitDy=0;entryX=0.25;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" source="EN7TMz6usMrMiW2YQY0C-2" target="EN7TMz6usMrMiW2YQY0C-12">
+ <mxGeometry relative="1" as="geometry">
+ <Array as="points">
+ <mxPoint x="455" y="760" />
+ <mxPoint x="230" y="760" />
+ </Array>
+ </mxGeometry>
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-2" value="" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#f5f5f5;strokeColor=#666666;fontColor=#333333;" vertex="1" parent="1">
+ <mxGeometry x="380" y="460" width="300" height="260" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-3" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.25;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="EN7TMz6usMrMiW2YQY0C-6" target="EN7TMz6usMrMiW2YQY0C-8">
+ <mxGeometry relative="1" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-4" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="EN7TMz6usMrMiW2YQY0C-6" target="EN7TMz6usMrMiW2YQY0C-7">
+ <mxGeometry relative="1" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-5" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.75;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="EN7TMz6usMrMiW2YQY0C-6" target="EN7TMz6usMrMiW2YQY0C-9">
+ <mxGeometry relative="1" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-6" value="" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#d5e8d4;strokeColor=#82b366;verticalAlign=middle;" vertex="1" parent="1">
+ <mxGeometry x="410" y="530" width="100" height="120" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-25" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.75;exitDx=0;exitDy=0;entryX=0.75;entryY=1;entryDx=0;entryDy=0;strokeWidth=2;" edge="1" parent="1" source="EN7TMz6usMrMiW2YQY0C-7" target="EN7TMz6usMrMiW2YQY0C-12">
+ <mxGeometry relative="1" as="geometry">
+ <Array as="points">
+ <mxPoint x="690" y="605" />
+ <mxPoint x="690" y="740" />
+ <mxPoint x="290" y="740" />
+ </Array>
+ </mxGeometry>
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-7" value="&lt;b&gt;UserProxyAgent&lt;/b&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#e1d5e7;strokeColor=#9673a6;" vertex="1" parent="1">
+ <mxGeometry x="550" y="560" width="100" height="60" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-8" value="Agent 1" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
+ <mxGeometry x="550" y="480" width="100" height="60" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-9" value="&lt;div&gt;Agent 3&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" vertex="1" parent="1">
+ <mxGeometry x="550" y="640" width="100" height="60" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-10" value="RoundRobinGroupChat" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+ <mxGeometry x="385" y="470" width="150" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-23" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.25;exitY=0;exitDx=0;exitDy=0;entryX=0.25;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="EN7TMz6usMrMiW2YQY0C-12" target="EN7TMz6usMrMiW2YQY0C-2">
+ <mxGeometry relative="1" as="geometry">
+ <Array as="points">
+ <mxPoint x="230" y="420" />
+ <mxPoint x="455" y="420" />
+ </Array>
+ </mxGeometry>
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-24" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.75;exitY=0;exitDx=0;exitDy=0;entryX=1;entryY=0.25;entryDx=0;entryDy=0;strokeWidth=2;" edge="1" parent="1" source="EN7TMz6usMrMiW2YQY0C-12" target="EN7TMz6usMrMiW2YQY0C-7">
+ <mxGeometry relative="1" as="geometry">
+ <Array as="points">
+ <mxPoint x="290" y="440" />
+ <mxPoint x="690" y="440" />
+ <mxPoint x="690" y="575" />
+ </Array>
+ </mxGeometry>
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-12" value="Application/User" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#ffe6cc;strokeColor=#d79b00;" vertex="1" parent="1">
+ <mxGeometry x="200" y="550" width="120" height="80" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-13" value="Task" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+ <mxGeometry x="180" y="495" width="60" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-14" value="TaskResult" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
+ <mxGeometry x="160" y="660" width="60" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-15" value="Termination&lt;div&gt;Condition&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#fff2cc;strokeColor=#d6b656;" vertex="1" parent="1">
+ <mxGeometry x="415" y="590" width="90" height="50" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-16" value="&lt;span style=&quot;text-wrap-mode: wrap;&quot;&gt;Orchestrator&lt;/span&gt;" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" vertex="1" parent="1">
+ <mxGeometry x="415" y="540" width="90" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-26" value="User Input Response" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;fontStyle=1" vertex="1" parent="1">
+ <mxGeometry x="690" y="530" width="140" height="30" as="geometry" />
+ </mxCell>
+ <mxCell id="EN7TMz6usMrMiW2YQY0C-27" value="Request for User Input" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;fontStyle=1" vertex="1" parent="1">
+ <mxGeometry x="690" y="620" width="140" height="30" as="geometry" />
+ </mxCell>
+ </root>
+ </mxGraphModel>
+ </diagram>
+</mxfile>
diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md
index d5df491a6..bfc6e8859 100644
--- a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md
+++ b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md
@@ -61,6 +61,7 @@ tutorial/models
tutorial/messages
tutorial/agents
tutorial/teams
+tutorial/human-in-the-loop
tutorial/selector-group-chat
tutorial/swarm
tutorial/termination
@@ -75,4 +76,3 @@ tutorial/state
examples/index
```
-
diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/human-in-the-loop-termination.svg b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/human-in-the-loop-termination.svg
new file mode 100644
index 000000000..6bfda4dd0
--- /dev/null
+++ b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/human-in-the-loop-termination.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="511px" height="360px" viewBox="-0.5 -0.5 511 360" class="ge-export-svg-auto" style="background-color: rgb(255, 255, 255);"><defs><style type="text/css">@media (prefers-color-scheme: dark) {&#xa;svg.ge-export-svg-auto:not(mjx-container &gt; svg) { filter: invert(100%) hue-rotate(180deg); }&#xa;svg.ge-export-svg-auto foreignObject img,&#xa;svg.ge-export-svg-auto image:not(svg.ge-export-svg-auto switch image),&#xa;svg.ge-export-svg-auto svg:not(mjx-container &gt; svg)&#xa;{ filter: invert(100%) hue-rotate(180deg) }&#xa;svg.ge-export-svg-auto { background-color: #000000 !important; }&#xa;}</style></defs><rect fill="#ffffff" width="100%" height="100%" x="0" y="0"/><g><g data-cell-id="0"><g data-cell-id="1"><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-1"><g><path d="M 285 310 L 285 330 L 90 330 L 90 228.24" fill="none" stroke="rgb(0, 0, 0)" stroke-width="2" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 90 222.24 L 94 230.24 L 90 228.24 L 86 230.24 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="2" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-2"><g><rect x="210" y="50" width="300" height="260" fill="#f5f5f5" stroke="#666666" pointer-events="all"/></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-3"><g><path d="M 340 150 L 360 150 L 360 100 L 373.63 100" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 378.88 100 L 371.88 103.5 L 373.63 100 L 371.88 96.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-4"><g><path d="M 340 180 L 373.63 180" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 378.88 180 L 371.88 183.5 L 373.63 180 L 371.88 176.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-5"><g><path d="M 340 210 L 360 210 L 360 260 L 373.63 260" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 378.88 260 L 371.88 263.5 L 373.63 260 L 371.88 256.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-6"><g><rect x="240" y="120" width="100" height="120" rx="15" ry="15" fill="#d5e8d4" stroke="#82b366" pointer-events="all"/></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-7"><g><rect x="380" y="150" width="100" height="60" rx="9" ry="9" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 180px; margin-left: 381px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Agent 2</div></div></div></foreignObject><text x="430" y="184" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Agent 2</text></switch></g></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-8"><g><rect x="380" y="70" width="100" height="60" rx="9" ry="9" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 100px; margin-left: 381px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Agent 1</div></div></div></foreignObject><text x="430" y="104" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Agent 1</text></switch></g></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-9"><g><rect x="380" y="230" width="100" height="60" rx="9" ry="9" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 260px; margin-left: 381px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><div>Agent 3</div></div></div></div></foreignObject><text x="430" y="264" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Agent 3</text></switch></g></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-10"><g><rect x="215" y="60" width="150" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 148px; height: 1px; padding-top: 75px; margin-left: 216px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">RoundRobinGroupChat</div></div></div></foreignObject><text x="290" y="79" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">RoundRobinGroupChat</text></switch></g></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-11"><g><path d="M 90 140 L 90 30 L 285 30 L 285 41.76" fill="none" stroke="rgb(0, 0, 0)" stroke-width="2" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 285 47.76 L 281 39.76 L 285 41.76 L 289 39.76 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="2" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-12"><g><rect x="30" y="140" width="120" height="80" rx="12" ry="12" fill="#ffe6cc" stroke="#d79b00" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 180px; margin-left: 31px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Application/User</div></div></div></foreignObject><text x="90" y="184" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Application/User</text></switch></g></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-13"><g><rect x="0" y="100" width="90" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 88px; height: 1px; padding-top: 115px; margin-left: 1px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;">Task/Feedback</div></div></div></foreignObject><text x="45" y="119" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle" font-weight="bold">Task/Feedback</text></switch></g></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-14"><g><rect x="20" y="250" width="60" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 58px; height: 1px; padding-top: 265px; margin-left: 21px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;">TaskResult</div></div></div></foreignObject><text x="50" y="269" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle" font-weight="bold">TaskResult</text></switch></g></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-15"><g><rect x="245" y="180" width="90" height="50" rx="7.5" ry="7.5" fill="#fff2cc" stroke="#d6b656" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 88px; height: 1px; padding-top: 205px; margin-left: 246px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><b>Termination</b><div><b>Condition</b></div></div></div></div></foreignObject><text x="290" y="209" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Termination...</text></switch></g></g></g><g data-cell-id="sYyRPZP6EHBJkb5ZCHJR-16"><g><rect x="245" y="130" width="90" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 145px; margin-left: 290px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><span style="text-wrap-mode: wrap;">Orchestrator</span></div></div></div></foreignObject><text x="290" y="149" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Orchestrator</text></switch></g></g></g><g data-cell-id="dF9Xe1aUO8W1j2Y2Youd-1"><g><rect x="110" y="0" width="160" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 158px; height: 1px; padding-top: 15px; margin-left: 111px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;">Starts / Resumes the Team</div></div></div></foreignObject><text x="190" y="19" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle" font-weight="bold">Starts / Resumes the Team</text></switch></g></g></g><g data-cell-id="dF9Xe1aUO8W1j2Y2Youd-2"><g><rect x="122.5" y="330" width="135" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 133px; height: 1px; padding-top: 345px; margin-left: 124px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: normal; overflow-wrap: normal;">Saves the Team's State</div></div></div></foreignObject><text x="190" y="349" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle" font-weight="bold">Saves the Team's State</text></switch></g></g></g></g></g></g></svg>
\ No newline at end of file
diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/human-in-the-loop-user-proxy.svg b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/human-in-the-loop-user-proxy.svg
new file mode 100644
index 000000000..77d9a2372
--- /dev/null
+++ b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/human-in-the-loop-user-proxy.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="670px" height="356px" viewBox="-0.5 -0.5 670 356" class="ge-export-svg-auto" style="background-color: rgb(255, 255, 255);"><defs><style type="text/css">@media (prefers-color-scheme: dark) {&#xa;svg.ge-export-svg-auto:not(mjx-container &gt; svg) { filter: invert(100%) hue-rotate(180deg); }&#xa;svg.ge-export-svg-auto foreignObject img,&#xa;svg.ge-export-svg-auto image:not(svg.ge-export-svg-auto switch image),&#xa;svg.ge-export-svg-auto svg:not(mjx-container &gt; svg)&#xa;{ filter: invert(100%) hue-rotate(180deg) }&#xa;svg.ge-export-svg-auto { background-color: #000000 !important; }&#xa;}</style></defs><rect fill="#ffffff" width="100%" height="100%" x="0" y="0"/><g><g data-cell-id="0"><g data-cell-id="1"><g data-cell-id="EN7TMz6usMrMiW2YQY0C-22"><g><path d="M 295 307 L 295 347 L 70 347 L 70 223.37" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 70 218.12 L 73.5 225.12 L 70 223.37 L 66.5 225.12 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-2"><g><rect x="220" y="47" width="300" height="260" fill="#f5f5f5" stroke="#666666" pointer-events="all"/></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-3"><g><path d="M 350 147 L 370 147 L 370 97 L 383.63 97" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 388.88 97 L 381.88 100.5 L 383.63 97 L 381.88 93.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-4"><g><path d="M 350 177 L 383.63 177" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 388.88 177 L 381.88 180.5 L 383.63 177 L 381.88 173.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-5"><g><path d="M 350 207 L 370 207 L 370 257 L 383.63 257" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 388.88 257 L 381.88 260.5 L 383.63 257 L 381.88 253.5 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-6"><g><rect x="250" y="117" width="100" height="120" rx="15" ry="15" fill="#d5e8d4" stroke="#82b366" pointer-events="all"/></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-25"><g><path d="M 490 192 L 530 192 L 530 327 L 130 327 L 130 225.24" fill="none" stroke="rgb(0, 0, 0)" stroke-width="2" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 130 219.24 L 134 227.24 L 130 225.24 L 126 227.24 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="2" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-7"><g><rect x="390" y="147" width="100" height="60" rx="9" ry="9" fill="#e1d5e7" stroke="#9673a6" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 177px; margin-left: 391px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><b>UserProxyAgent</b></div></div></div></foreignObject><text x="440" y="181" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">UserProxyAgent</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-8"><g><rect x="390" y="67" width="100" height="60" rx="9" ry="9" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 97px; margin-left: 391px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Agent 1</div></div></div></foreignObject><text x="440" y="101" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Agent 1</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-9"><g><rect x="390" y="227" width="100" height="60" rx="9" ry="9" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 98px; height: 1px; padding-top: 257px; margin-left: 391px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;"><div>Agent 3</div></div></div></div></foreignObject><text x="440" y="261" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Agent 3</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-10"><g><rect x="225" y="57" width="150" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 148px; height: 1px; padding-top: 72px; margin-left: 226px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">RoundRobinGroupChat</div></div></div></foreignObject><text x="300" y="76" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">RoundRobinGroupChat</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-23"><g><path d="M 70 137 L 70 7 L 295 7 L 295 40.63" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 295 45.88 L 291.5 38.88 L 295 40.63 L 298.5 38.88 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-24"><g><path d="M 130 137 L 130 27 L 530 27 L 530 162 L 498.24 162" fill="none" stroke="rgb(0, 0, 0)" stroke-width="2" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 492.24 162 L 500.24 158 L 498.24 162 L 500.24 166 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-width="2" stroke-miterlimit="10" pointer-events="all"/></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-12"><g><rect x="40" y="137" width="120" height="80" rx="12" ry="12" fill="#ffe6cc" stroke="#d79b00" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 118px; height: 1px; padding-top: 177px; margin-left: 41px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Application/User</div></div></div></foreignObject><text x="100" y="181" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Application/User</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-13"><g><rect x="20" y="82" width="60" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 58px; height: 1px; padding-top: 97px; margin-left: 21px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Task</div></div></div></foreignObject><text x="50" y="101" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Task</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-14"><g><rect x="0" y="247" width="60" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 58px; height: 1px; padding-top: 262px; margin-left: 1px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">TaskResult</div></div></div></foreignObject><text x="30" y="266" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">TaskResult</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-15"><g><rect x="255" y="177" width="90" height="50" rx="7.5" ry="7.5" fill="#fff2cc" stroke="#d6b656" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 88px; height: 1px; padding-top: 202px; margin-left: 256px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Termination<div>Condition</div></div></div></div></foreignObject><text x="300" y="206" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Termination...</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-16"><g><rect x="255" y="127" width="90" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 142px; margin-left: 300px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: nowrap;"><span style="text-wrap-mode: wrap;">Orchestrator</span></div></div></div></foreignObject><text x="300" y="146" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle">Orchestrator</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-26"><g><rect x="530" y="117" width="140" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 132px; margin-left: 600px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: nowrap;">User Input Response</div></div></div></foreignObject><text x="600" y="136" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle" font-weight="bold">User Input Response</text></switch></g></g></g><g data-cell-id="EN7TMz6usMrMiW2YQY0C-27"><g><rect x="530" y="207" width="140" height="30" fill="none" stroke="none" pointer-events="all"/></g><g><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 222px; margin-left: 600px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; font-weight: bold; white-space: nowrap;">Request for User Input</div></div></div></foreignObject><text x="600" y="226" fill="rgb(0, 0, 0)" font-family="&quot;Helvetica&quot;" font-size="12px" text-anchor="middle" font-weight="bold">Request for User Input</text></switch></g></g></g></g></g></g></svg>
\ No newline at end of file
diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/human-in-the-loop.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/human-in-the-loop.ipynb
new file mode 100644
index 000000000..7862fecea
--- /dev/null
+++ b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/human-in-the-loop.ipynb
@@ -0,0 +1,439 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Human-in-the-Loop\n",
+ "\n",
+ "In the previous section [Teams](./teams.ipynb), we have seen how to create, observe,\n",
+ "and control a team of agents.\n",
+ "This section will focus on how to interact with the team from your application,\n",
+ "and provide human feedback to the team.\n",
+ "\n",
+ "There are two main ways to interact with the team from your application:\n",
+ "\n",
+ "1. During a team's run -- execution of {py:meth}`~autogen_agentchat.teams.BaseGroupChat.run` or {py:meth}`~autogen_agentchat.teams.BaseGroupChat.run_stream`, provide feedback through a {py:class}`~autogen_agentchat.agents.UserProxyAgent`.\n",
+ "2. Once the run terminates, provide feedback through input to the next call to {py:meth}`~autogen_agentchat.teams.BaseGroupChat.run` or {py:meth}`~autogen_agentchat.teams.BaseGroupChat.run_stream`.\n"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## Providing Feedback During a Run\n",
+ "\n",
+ "The {py:class}`~autogen_agentchat.agents.UserProxyAgent` is a special built-in agent\n",
+ "that acts as a proxy for a user to provide feedback to the team.\n",
+ "\n",
+ "To use the {py:class}`~autogen_agentchat.agents.UserProxyAgent`, you can create an instance of it\n",
+ "and include it in the team before running the team.\n",
+ "The team will decide when to call the {py:class}`~autogen_agentchat.agents.UserProxyAgent`\n",
+ "to ask for feedback from the user.\n",
+ "\n",
+ "The following diagram illustrates how you can use \n",
+ "{py:class}`~autogen_agentchat.agents.UserProxyAgent`\n",
+ "to get feedback from the user during a team's run:\n",
+ "\n",
+ "![human-in-the-loop-user-proxy](./human-in-the-loop-user-proxy.svg)\n",
+ "\n",
+ "The bold arrows indicates the flow of control during a team's run:\n",
+ "when the team calls the {py:class}`~autogen_agentchat.agents.UserProxyAgent`,\n",
+ "it transfers the control to the application/user, and waits for the feedback;\n",
+ "once the feedback is provided, the control is transferred back to the team\n",
+ "and the team continues its execution.\n",
+ "\n",
+ "```{note}\n",
+ "When {py:class}`~autogen_agentchat.agents.UserProxyAgent` is called during a run,\n",
+ "it blocks the execution of the team until the user provides feedback or errors out.\n",
+ "This will hold up the team's progress and put the team in an unstable state\n",
+ "that cannot be saved or resumed.\n",
+ "```\n",
+ "\n",
+ "Due to the blocking nature of this approach, it is recommended to use it only for short interactions\n",
+ "that require immediate feedback from the user, such as asking for approval or disapproval\n",
+ "with a button click, or an alert requiring immediate attention otherwise failing the task.\n",
+ "\n",
+ "Here is an example of how to use the {py:class}`~autogen_agentchat.agents.UserProxyAgent`\n",
+ "in a {py:class}`~autogen_agentchat.teams.RoundRobinGroupChat` for a poetry generation task:"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 1,
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "---------- user ----------\n",
+ "Write a 4-line poem about the ocean.\n",
+ "---------- assistant ----------\n",
+ "Waves whisper secrets to the shore’s embrace, \n",
+ "A dance of blue under the sun's warm grace. \n",
+ "Endless horizons where dreams take flight, \n",
+ "The ocean's heart glimmers, a canvas of light. \n",
+ "TERMINATE\n",
+ "[Prompt tokens: 46, Completion tokens: 49]\n",
+ "---------- user_proxy ----------\n",
+ "APPROVE\n",
+ "---------- Summary ----------\n",
+ "Number of messages: 3\n",
+ "Finish reason: Text 'APPROVE' mentioned\n",
+ "Total prompt tokens: 46\n",
+ "Total completion tokens: 49\n",
+ "Duration: 6.64 seconds\n"
+ ]
+ },
+ {
+ "data": {
+ "text/plain": [
+ "TaskResult(messages=[TextMessage(source='user', models_usage=None, content='Write a 4-line poem about the ocean.', type='TextMessage'), TextMessage(source='assistant', models_usage=RequestUsage(prompt_tokens=46, completion_tokens=49), content=\"Waves whisper secrets to the shore’s embrace, \\nA dance of blue under the sun's warm grace. \\nEndless horizons where dreams take flight, \\nThe ocean's heart glimmers, a canvas of light. \\nTERMINATE\", type='TextMessage'), TextMessage(source='user_proxy', models_usage=None, content='APPROVE', type='TextMessage')], stop_reason=\"Text 'APPROVE' mentioned\")"
+ ]
+ },
+ "execution_count": 1,
+ "metadata": {},
+ "output_type": "execute_result"
+ }
+ ],
+ "source": [
+ "from autogen_agentchat.agents import AssistantAgent, UserProxyAgent\n",
+ "from autogen_agentchat.conditions import TextMentionTermination\n",
+ "from autogen_agentchat.teams import RoundRobinGroupChat\n",
+ "from autogen_agentchat.ui import Console\n",
+ "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
+ "\n",
+ "# Create the agents.\n",
+ "model_client = OpenAIChatCompletionClient(model=\"gpt-4o-mini\")\n",
+ "assistant = AssistantAgent(\"assistant\", model_client=model_client)\n",
+ "user_proxy = UserProxyAgent(\"user_proxy\", input_func=input) # Use input() to get user input from console.\n",
+ "\n",
+ "# Create the termination condition which will end the conversation when the user says \"APPROVE\".\n",
+ "termination = TextMentionTermination(\"APPROVE\")\n",
+ "\n",
+ "# Create the team.\n",
+ "team = RoundRobinGroupChat([assistant, user_proxy], termination_condition=termination)\n",
+ "\n",
+ "# Run the conversation and stream to the console.\n",
+ "stream = team.run_stream(task=\"Write a 4-line poem about the ocean.\")\n",
+ "# Use asyncio.run(...) when running in a script.\n",
+ "await Console(stream)"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "From the console output, you can see the team solicited feedback from the user\n",
+ "through `user_proxy` to approve the generated poem.\n",
+ "\n",
+ "You can provide your own input function to the {py:class}`~autogen_agentchat.agents.UserProxyAgent`\n",
+ "to customize the feedback process."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## Providing Feedback to the Next Run\n",
+ "\n",
+ "Often times, an application or a user interacts with the team of agents in an interactive loop:\n",
+ "the team runs until termination, \n",
+ "the application or user provides feedback, and the team runs again with the feedback.\n",
+ "\n",
+ "This approach is useful in a persisted session\n",
+ "with asynchronous communication between the team and the application/user:\n",
+ "Once a team finishes a run, the application saves the state of the team,\n",
+ "puts it in a persistent storage, and resumes the team when the feedback arrives.\n",
+ "\n",
+ "```{note}\n",
+ "For how to save and load the state of a team, please refer to [Managing State](./state.ipynb).\n",
+ "This section will focus on the feedback mechanisms.\n",
+ "```\n",
+ "\n",
+ "The following diagram illustrates the flow of control in this approach:\n",
+ "\n",
+ "![human-in-the-loop-termination](./human-in-the-loop-termination.svg)\n",
+ "\n",
+ "There are two ways to implement this approach:\n",
+ "\n",
+ "- Set the maximum number of turns so that the team always stops after the specified number of turns.\n",
+ "- Use termination conditions such as {py:class}`~autogen_agentchat.conditions.TextMentionTermination` and {py:class}`~autogen_agentchat.conditions.HandoffTermination` to allow the team to decide when to stop and give control back, given the team's internal state.\n",
+ "\n",
+ "You can use both methods together to achieve your desired behavior."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "### Using Max Turns\n",
+ "\n",
+ "This method allows you to pause the team for user input by setting a maximum number of turns. For instance, you can configure the team to stop after the first agent responds by setting `max_turns` to 1. This is particularly useful in scenarios where continuous user engagement is required, such as in a chatbot.\n",
+ "\n",
+ "To implement this, set the `max_turns` parameter in the {py:meth}`~autogen_agentchat.teams.RoundRobinGroupChat` constructor.\n",
+ "\n",
+ "```python\n",
+ "team = RoundRobinGroupChat([...], max_turns=1)\n",
+ "```\n",
+ "\n",
+ "Once the team stops, the turn count will be reset. When you resume the team,\n",
+ "it will start from 0 again. However, the team's internal state will be preserved,\n",
+ "for example, the {py:class}`~autogen_agentchat.teams.RoundRobinGroupChat` will\n",
+ "resume from the next agent in the list with the same conversation history.\n",
+ "\n",
+ "```{note}\n",
+ "`max_turn` is specific to the team class and is currently only supported by\n",
+ "{py:class}`~autogen_agentchat.teams.RoundRobinGroupChat`, {py:class}`~autogen_agentchat.teams.SelectorGroupChat`, and {py:class}`~autogen_agentchat.teams.Swarm`.\n",
+ "When used with termination conditions, the team will stop when either condition is met.\n",
+ "```\n",
+ "\n",
+ "Here is an example of how to use `max_turns` in a {py:class}`~autogen_agentchat.teams.RoundRobinGroupChat` for a poetry generation task\n",
+ "with a maximum of 1 turn:"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 2,
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "---------- user ----------\n",
+ "Write a 4-line poem about the ocean.\n",
+ "---------- assistant ----------\n",
+ "Endless waves in a dance with the shore, \n",
+ "Whispers of secrets in tales from the roar, \n",
+ "Beneath the vast sky, where horizons blend, \n",
+ "The ocean’s embrace is a timeless friend. \n",
+ "TERMINATE\n",
+ "[Prompt tokens: 46, Completion tokens: 48]\n",
+ "---------- Summary ----------\n",
+ "Number of messages: 2\n",
+ "Finish reason: Maximum number of turns 1 reached.\n",
+ "Total prompt tokens: 46\n",
+ "Total completion tokens: 48\n",
+ "Duration: 1.63 seconds\n",
+ "---------- user ----------\n",
+ "Can you make it about a person and its relationship with the ocean\n",
+ "---------- assistant ----------\n",
+ "She walks along the tide, where dreams intertwine, \n",
+ "With every crashing wave, her heart feels aligned, \n",
+ "In the ocean's embrace, her worries dissolve, \n",
+ "A symphony of solace, where her spirit evolves. \n",
+ "TERMINATE\n",
+ "[Prompt tokens: 117, Completion tokens: 49]\n",
+ "---------- Summary ----------\n",
+ "Number of messages: 2\n",
+ "Finish reason: Maximum number of turns 1 reached.\n",
+ "Total prompt tokens: 117\n",
+ "Total completion tokens: 49\n",
+ "Duration: 1.21 seconds\n"
+ ]
+ }
+ ],
+ "source": [
+ "from autogen_agentchat.agents import AssistantAgent\n",
+ "from autogen_agentchat.teams import RoundRobinGroupChat\n",
+ "from autogen_agentchat.ui import Console\n",
+ "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
+ "\n",
+ "# Create the agents.\n",
+ "model_client = OpenAIChatCompletionClient(model=\"gpt-4o-mini\")\n",
+ "assistant = AssistantAgent(\"assistant\", model_client=model_client)\n",
+ "\n",
+ "# Create the team setting a maximum number of turns to 1.\n",
+ "team = RoundRobinGroupChat([assistant], max_turns=1)\n",
+ "\n",
+ "task = \"Write a 4-line poem about the ocean.\"\n",
+ "while True:\n",
+ " # Run the conversation and stream to the console.\n",
+ " stream = team.run_stream(task=task)\n",
+ " # Use asyncio.run(...) when running in a script.\n",
+ " await Console(stream)\n",
+ " # Get the user response.\n",
+ " task = input(\"Enter your feedback (type 'exit' to leave): \")\n",
+ " if task.lower().strip() == \"exit\":\n",
+ " break"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "You can see that the team stopped immediately after one agent responded."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "### Using Termination Conditions\n",
+ "\n",
+ "We have already seen several examples of termination conditions in the previous sections.\n",
+ "In this section, we focus on {py:class}`~autogen_agentchat.conditions.HandoffTermination`\n",
+ "which stops the team when an agent sends a {py:class}`~autogen_agentchat.messages.HandoffMessage` message.\n",
+ "\n",
+ "Let's create a team with a single {py:class}`~autogen_agentchat.agents.AssistantAgent` agent\n",
+ "with a handoff setting, and run the team with a task that requires additional input from the user\n",
+ "because the agent doesn't have relevant tools to continue processing the task.\n",
+ "\n",
+ "```{note}\n",
+ "The model used with {py:class}`~autogen_agentchat.agents.AssistantAgent` must support tool call\n",
+ "to use the handoff feature.\n",
+ "```"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 4,
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "---------- user ----------\n",
+ "What is the weather in New York?\n",
+ "---------- lazy_assistant ----------\n",
+ "[FunctionCall(id='call_nSjgvWCUYo5ccacBz7yzrPLN', arguments='{}', name='transfer_to_user')]\n",
+ "[Prompt tokens: 68, Completion tokens: 12]\n",
+ "---------- lazy_assistant ----------\n",
+ "[FunctionExecutionResult(content='Transfer to user.', call_id='call_nSjgvWCUYo5ccacBz7yzrPLN')]\n",
+ "---------- lazy_assistant ----------\n",
+ "Transfer to user.\n",
+ "---------- Summary ----------\n",
+ "Number of messages: 4\n",
+ "Finish reason: Handoff to user from lazy_assistant detected.\n",
+ "Total prompt tokens: 68\n",
+ "Total completion tokens: 12\n",
+ "Duration: 0.75 seconds\n"
+ ]
+ },
+ {
+ "data": {
+ "text/plain": [
+ "TaskResult(messages=[TextMessage(source='user', models_usage=None, content='What is the weather in New York?', type='TextMessage'), ToolCallRequestEvent(source='lazy_assistant', models_usage=RequestUsage(prompt_tokens=68, completion_tokens=12), content=[FunctionCall(id='call_nSjgvWCUYo5ccacBz7yzrPLN', arguments='{}', name='transfer_to_user')], type='ToolCallRequestEvent'), ToolCallExecutionEvent(source='lazy_assistant', models_usage=None, content=[FunctionExecutionResult(content='Transfer to user.', call_id='call_nSjgvWCUYo5ccacBz7yzrPLN')], type='ToolCallExecutionEvent'), HandoffMessage(source='lazy_assistant', models_usage=None, target='user', content='Transfer to user.', type='HandoffMessage')], stop_reason='Handoff to user from lazy_assistant detected.')"
+ ]
+ },
+ "execution_count": 4,
+ "metadata": {},
+ "output_type": "execute_result"
+ }
+ ],
+ "source": [
+ "from autogen_agentchat.agents import AssistantAgent\n",
+ "from autogen_agentchat.base import Handoff\n",
+ "from autogen_agentchat.conditions import HandoffTermination, TextMentionTermination\n",
+ "from autogen_agentchat.teams import RoundRobinGroupChat\n",
+ "from autogen_agentchat.ui import Console\n",
+ "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
+ "\n",
+ "# Create an OpenAI model client.\n",
+ "model_client = OpenAIChatCompletionClient(\n",
+ " model=\"gpt-4o-2024-08-06\",\n",
+ " # api_key=\"sk-...\", # Optional if you have an OPENAI_API_KEY env variable set.\n",
+ ")\n",
+ "\n",
+ "# Create a lazy assistant agent that always hands off to the user.\n",
+ "lazy_agent = AssistantAgent(\n",
+ " \"lazy_assistant\",\n",
+ " model_client=model_client,\n",
+ " handoffs=[Handoff(target=\"user\", message=\"Transfer to user.\")],\n",
+ " system_message=\"Always transfer to user when you don't know the answer. Respond 'TERMINATE' when task is complete.\",\n",
+ ")\n",
+ "\n",
+ "# Define a termination condition that checks for handoff message targetting helper and text \"TERMINATE\".\n",
+ "handoff_termination = HandoffTermination(target=\"user\")\n",
+ "text_termination = TextMentionTermination(\"TERMINATE\")\n",
+ "combined_termination = handoff_termination | text_termination\n",
+ "\n",
+ "# Create a single-agent team.\n",
+ "lazy_agent_team = RoundRobinGroupChat([lazy_agent], termination_condition=combined_termination)\n",
+ "\n",
+ "# Run the team and stream to the console.\n",
+ "task = \"What is the weather in New York?\"\n",
+ "await Console(lazy_agent_team.run_stream(task=task))"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "You can see the team stopped due to the handoff message was detected.\n",
+ "Let's continue the team by providing the information the agent needs."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 5,
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "---------- user ----------\n",
+ "The weather in New York is sunny.\n",
+ "---------- lazy_assistant ----------\n",
+ "Great to hear that it's sunny in New York! Is there anything else you'd like to know or discuss?\n",
+ "[Prompt tokens: 109, Completion tokens: 23]\n",
+ "---------- lazy_assistant ----------\n",
+ "TERMINATE\n",
+ "[Prompt tokens: 138, Completion tokens: 5]\n",
+ "---------- Summary ----------\n",
+ "Number of messages: 3\n",
+ "Finish reason: Text 'TERMINATE' mentioned\n",
+ "Total prompt tokens: 247\n",
+ "Total completion tokens: 28\n",
+ "Duration: 1.44 seconds\n"
+ ]
+ },
+ {
+ "data": {
+ "text/plain": [
+ "TaskResult(messages=[TextMessage(source='user', models_usage=None, content='The weather in New York is sunny.', type='TextMessage'), TextMessage(source='lazy_assistant', models_usage=RequestUsage(prompt_tokens=109, completion_tokens=23), content=\"Great to hear that it's sunny in New York! Is there anything else you'd like to know or discuss?\", type='TextMessage'), TextMessage(source='lazy_assistant', models_usage=RequestUsage(prompt_tokens=138, completion_tokens=5), content='TERMINATE', type='TextMessage')], stop_reason=\"Text 'TERMINATE' mentioned\")"
+ ]
+ },
+ "execution_count": 5,
+ "metadata": {},
+ "output_type": "execute_result"
+ }
+ ],
+ "source": [
+ "await Console(lazy_agent_team.run_stream(task=\"The weather in New York is sunny.\"))"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "You can see the team continued after the user provided the information."
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": ".venv",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.11.5"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}