Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Documentation for UserProxyAgent #4332

Closed
husseinmozannar opened this issue Nov 24, 2024 · 2 comments · Fixed by #4401
Closed

Add Documentation for UserProxyAgent #4332

husseinmozannar opened this issue Nov 24, 2024 · 2 comments · Fixed by #4401
Assignees
Labels
documentation Improvements or additions to documentation proj-agentchat
Milestone

Comments

@husseinmozannar
Copy link
Contributor

husseinmozannar commented Nov 24, 2024

We need to add documentation for UserProxyAgent introduced in PR #4255

Comment from @ekzhu :

In the doc we need to make the case that there are multiple ways for human in the loop, and user proxy agent is a way that puts the team in a temporary blocking state that cannot be recovered if exception or failure happens. So it should be used with timeout and make sure the exceptions are catched and handled. This approach of human in the loop is for scenarios like just-in-time approval, feedback, alert, etc. For slow human in the loop, consider terminating the team run using termination condition and issue another one from run or run_stream with another message.

@ekzhu
Copy link
Collaborator

ekzhu commented Nov 25, 2024

Also update the tutorial section which has an example for user proxy agent. Consider removing that or changing it to something else.

https://microsoft.github.io/autogen/dev/user-guide/agentchat-user-guide/tutorial/custom-agents.html#userproxyagent

@peterychang
Copy link
Collaborator

Also update the tutorial section which has an example for user proxy agent. Consider removing that or changing it to something else.

https://microsoft.github.io/autogen/dev/user-guide/agentchat-user-guide/tutorial/custom-agents.html#userproxyagent

I'll add a section to the agentchat agents section mentioning the UserAgent and its quirks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation proj-agentchat
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants