Add websockets for streaming to a frontend

[Tylersuard]

@sonichi

Why are these changes needed?

If a user wants to have a frontend for an autogen-based chat, websockets will be required to stream information out of autogen. These changes will allow the user to stream content from a conversation to any address they choose. See https://websockets.readthedocs.io/en/stable/

Related issue number

#1199 , #1143 , #217 , #394

Checks

• I've included any doc changes needed for https://microsoft.github.io/autogen/. See https://microsoft.github.io/autogen/docs/Contribute#documentation to build and test documentation locally.
• I've added tests (if relevant) corresponding to the changes introduced in this PR.
• I've made sure all auto checks have passed.

[Tylersuard]

@sonichi the code formatting test is failing on scripts that I didn't write. Also, I have no idea why adding websockets would interfere with the WebSurfer tests, but it's happening with other PR's as well.

[codecov-commenter]

Codecov Report

Attention: 14 lines in your changes are missing coverage. Please review.

Comparison is base (015070b) 33.12% compared to head (76c8770) 4.17%.

Files	Patch %	Lines
autogen/agentchat/conversable_agent.py	0.00%	6 Missing ⚠️
autogen/oai/client.py	33.33%	4 Missing ⚠️
autogen/streaming_utils.py	0.00%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #1414       +/-   ##
==========================================
- Coverage   33.12%   4.17%   -28.95%     
==========================================
  Files          42      41        -1     
  Lines        5051    5054        +3     
  Branches     1157    1225       +68     
==========================================
- Hits         1673     211     -1462     
- Misses       3250    4833     +1583     
+ Partials      128      10      -118     

Flag	Coverage Δ
unittests	4.17% <12.50%> (-28.91%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[davorrunje]

@Tylersuard do you want me to look into failing tests?

[ekzhu]

looks like we might be getting a dangling PR here.

@davorrunje would you be interested in taking over this?

[Tylersuard]

@davorrunje @ekzhu Yes Davor, please look into the failing tests. Eric, I am still not sure what is required of me at this point. You asked me to write a protocol, and I think I did that? What else do I need to write or change?

…

On Sun, Feb 4, 2024 at 2:10 AM, Eric Zhu ***@***.***(mailto:On Sun, Feb 4, 2024 at 2:10 AM, Eric Zhu <<a href=)> wrote: looks like we might be getting a dangling PR here. ***@***.***(https://github.com/davorrunje) would you be interested in taking over this? — Reply to this email directly, [view it on GitHub](#1414 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/AJ6H6YLQBFUR2FYPFCDUQA3YR5NBPAVCNFSM6AAAAABCMLELACVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMRVGY3TINJZHA). You are receiving this because you were mentioned.Message ID: ***@***.***>

[ekzhu]

@Tylersuard you can see my comments in the code. There is a recent change to the oai/client.py that conflicts with the changes you made. So there is work in redoing your changes but in the new oai/client.py. There are a couple minor comments I have that could be addressed.