Override OpenAIWrapper | hook streams and other client mechanisms

[bitnom]

Why are these changes needed?

Give end-developers a way to hook the openai wrapper without having to duplicate huge blocks of code. This can be used to easily hook streamed responses with a generator. Now it is relatively painless to override client.chat.completions.create for instance.

I do realize Custom Client support #831 exists. This PR is something I implemented to accomplish a goal ahead of such merges, and so I share.

Related issues

#1199 and probably others. A follow-up PR for passing arbitrary data from request messages through to their responses will be a better moment to go around closing issues where hooks have been requested. I will make that PR encompass as many of those issues as possible by also supporting callbacks, which is currently in the works.

There are many related issues and ongoing works. I'll just reference #217 for brevity.

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.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d6a3304) 31.45% compared to head (bc2dccd) 41.35%.
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1217      +/-   ##
==========================================
+ Coverage   31.45%   41.35%   +9.89%     
==========================================
  Files          32       32              
  Lines        4393     4396       +3     
  Branches     1026     1081      +55     
==========================================
+ Hits         1382     1818     +436     
+ Misses       2902     2437     -465     
- Partials      109      141      +32     

Flag	Coverage Δ
unittests	41.28% <100.00%> (+9.87%)	⬆️

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.

[ekzhu]

Thanks for the PR! I think this is very much inline with the custom client effort @olgavrou is doing also with the discussion @davorrunje and I had in #1227. I am wondering if you are interested in continuing the work in #831? We can have a new PR as the old one seems quite outdated.

[bitnom]

Thanks for the PR! I think this is very much inline with the custom client effort @olgavrou is doing also with the discussion @davorrunje and I had in #1227. I am wondering if you are interested in continuing the work in #831? We can have a new PR as the old one seems quite outdated.

np. Sure, I'll do it. I have continue in this vein anyway for my work.

I'll make a new issue and/or draft outlining what should be done, and continue from there. We need to be able to pass arbitrary data from any initiating message through to its response(s).

[bitnom]

I presume somebody is going to ask me to write a test here. I have been using the PR with success for a few days, and will add a test shortly.

[bitnom]

For anyone coming here from other PRs/issues looking for various forms of overrides and hooks, it looks like the major effort for that will be: #1240

[ekzhu]

I presume somebody is going to ask me to write a test here. I have been using the PR with success for a few days, and will add a test shortly.

Let's focus on working on this #1240 first? Regarding wrapper client we have many hands already.

[ekzhu]

@bitnom There have been many recent changes e.g., the custom client and recent work on streming #1551. Do you still want to pursue this PR?

[bitnom]

@bitnom There have been many recent changes e.g., the custom client and recent work on streming #1551. Do you still want to pursue this PR?

I'll be getting back to autogen PRs this weekend, and will re-evaluate my PRs and issues at that point. Other work had taken me out of it for a bit. I still think it's important to be able to override but I need to get caught-up and see where everything is at.

edit: I had put some comments about making iostream protocol agnostic but I now see it seems to be.

[gitguardian]

⚠️ GitGuardian has uncovered 96 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
12853598	Triggered	Generic High Entropy Secret	79dbb7b	test/oai/test_utils.py	View secret
10404693	Triggered	Generic High Entropy Secret	e43a86c	test/oai/test_utils.py	View secret
10404693	Triggered	Generic High Entropy Secret	bdb40d7	test/oai/test_utils.py	View secret
10404693	Triggered	Generic High Entropy Secret	954ca45	test/oai/test_utils.py	View secret
10404693	Triggered	Generic High Entropy Secret	79dbb7b	test/oai/test_utils.py	View secret
10404662	Triggered	Generic CLI Secret	eff19ac	.github/workflows/dotnet-release.yml	View secret
10404662	Triggered	Generic CLI Secret	06a0a5d	.github/workflows/dotnet-release.yml	View secret
10404662	Triggered	Generic CLI Secret	0524c77	.github/workflows/dotnet-release.yml	View secret
10404662	Triggered	Generic CLI Secret	d7ea410	.github/workflows/dotnet-release.yml	View secret
10404662	Triggered	Generic CLI Secret	e43a86c	.github/workflows/dotnet-build.yml	View secret
10404662	Triggered	Generic CLI Secret	841ed31	.github/workflows/dotnet-release.yml	View secret
10404662	Triggered	Generic CLI Secret	802f099	.github/workflows/dotnet-release.yml	View secret
10404662	Triggered	Generic CLI Secret	9a484d8	.github/workflows/dotnet-build.yml	View secret
10404662	Triggered	Generic CLI Secret	e973ac3	.github/workflows/dotnet-release.yml	View secret
10404662	Triggered	Generic CLI Secret	89650e7	.github/workflows/dotnet-release.yml	View secret
10404662	Triggered	Generic CLI Secret	e07b06b	.github/workflows/dotnet-release.yml	View secret
10404662	Triggered	Generic CLI Secret	abe4c41	.github/workflows/dotnet-build.yml	View secret
10404662	Triggered	Generic CLI Secret	7362fb9	.github/workflows/dotnet-release.yml	View secret
12853599	Triggered	Generic High Entropy Secret	79dbb7b	test/oai/test_utils.py	View secret
10404694	Triggered	Generic High Entropy Secret	e43a86c	test/oai/test_utils.py	View secret
10404694	Triggered	Generic High Entropy Secret	954ca45	test/oai/test_utils.py	View secret
10404694	Triggered	Generic High Entropy Secret	bdb40d7	test/oai/test_utils.py	View secret
10404695	Triggered	Generic High Entropy Secret	abad9ff	test/oai/test_utils.py	View secret
10404695	Triggered	Generic High Entropy Secret	954ca45	test/oai/test_utils.py	View secret
10404695	Triggered	Generic High Entropy Secret	c7bb588	test/oai/test_utils.py	View secret
10404695	Triggered	Generic High Entropy Secret	b97b99d	test/oai/test_utils.py	View secret
10404695	Triggered	Generic High Entropy Secret	e43a86c	test/oai/test_utils.py	View secret
12853600	Triggered	Generic High Entropy Secret	79dbb7b	test/oai/test_utils.py	View secret
12853601	Triggered	Generic High Entropy Secret	79dbb7b	test/oai/test_utils.py	View secret
10493810	Triggered	Generic Password	49e8053	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	501610b	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	49e8053	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	501610b	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	d422c63	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	97fa339	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	49e8053	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	d422c63	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	97fa339	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	d422c63	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	97fa339	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	501610b	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10404696	Triggered	Generic High Entropy Secret	954ca45	test/oai/test_utils.py	View secret
10404696	Triggered	Generic High Entropy Secret	bdb40d7	test/oai/test_utils.py	View secret
10404696	Triggered	Generic High Entropy Secret	79dbb7b	test/oai/test_utils.py	View secret
10404696	Triggered	Generic High Entropy Secret	e43a86c	test/oai/test_utils.py	View secret
10422482	Triggered	Generic High Entropy Secret	79dbb7b	test/oai/test_utils.py	View secret
10422482	Triggered	Generic High Entropy Secret	bdb40d7	test/oai/test_utils.py	View secret
12853602	Triggered	Generic High Entropy Secret	79dbb7b	test/oai/test_utils.py	View secret
11616921	Triggered	Generic High Entropy Secret	a86d0fd	notebook/agentchat_agentops.ipynb	View secret
11616921	Triggered	Generic High Entropy Secret	394561b	notebook/agentchat_agentops.ipynb	View secret
11616921	Triggered	Generic High Entropy Secret	3eac646	notebook/agentchat_agentops.ipynb	View secret
11616921	Triggered	Generic High Entropy Secret	f45b553	notebook/agentchat_agentops.ipynb	View secret
11616921	Triggered	Generic High Entropy Secret	6563248	notebook/agentchat_agentops.ipynb	View secret
12853598	Triggered	Generic High Entropy Secret	2b3a9ae	test/oai/test_utils.py	View secret
12853598	Triggered	Generic High Entropy Secret	c03558f	test/oai/test_utils.py	View secret
10404693	Triggered	Generic High Entropy Secret	c03558f	test/oai/test_utils.py	View secret
10404693	Triggered	Generic High Entropy Secret	2b3a9ae	test/oai/test_utils.py	View secret
10404693	Triggered	Generic High Entropy Secret	0a3c6c4	test/oai/test_utils.py	View secret
10404693	Triggered	Generic High Entropy Secret	76f5f5a	test/oai/test_utils.py	View secret
10404662	Triggered	Generic CLI Secret	954ca45	.github/workflows/dotnet-build.yml	View secret
12853599	Triggered	Generic High Entropy Secret	2b3a9ae	test/oai/test_utils.py	View secret
12853599	Triggered	Generic High Entropy Secret	c03558f	test/oai/test_utils.py	View secret
10404694	Triggered	Generic High Entropy Secret	76f5f5a	test/oai/test_utils.py	View secret
10404694	Triggered	Generic High Entropy Secret	0a3c6c4	test/oai/test_utils.py	View secret
10404695	Triggered	Generic High Entropy Secret	3b79cc6	test/oai/test_utils.py	View secret
10404695	Triggered	Generic High Entropy Secret	11baa52	test/oai/test_utils.py	View secret
12853600	Triggered	Generic High Entropy Secret	c03558f	test/oai/test_utils.py	View secret
12853600	Triggered	Generic High Entropy Secret	2b3a9ae	test/oai/test_utils.py	View secret
12853601	Triggered	Generic High Entropy Secret	c03558f	test/oai/test_utils.py	View secret
12853601	Triggered	Generic High Entropy Secret	2b3a9ae	test/oai/test_utils.py	View secret
10493810	Triggered	Generic Password	3b79cc6	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	11baa52	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	11baa52	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10493810	Triggered	Generic Password	3b79cc6	notebook/agentchat_pgvector_RetrieveChat.ipynb	View secret
10404696	Triggered	Generic High Entropy Secret	0a3c6c4	test/oai/test_utils.py	View secret
10404696	Triggered	Generic High Entropy Secret	76f5f5a	test/oai/test_utils.py	View secret
10404696	Triggered	Generic High Entropy Secret	c03558f	test/oai/test_utils.py	View secret
10404696	Triggered	Generic High Entropy Secret	2b3a9ae	test/oai/test_utils.py	View secret
10422482	Triggered	Generic High Entropy Secret	2b3a9ae	test/oai/test_utils.py	View secret
10422482	Triggered	Generic High Entropy Secret	c03558f	test/oai/test_utils.py	View secret

and 16 others.

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

[gagb]

Closing because of inactivity. Please reopen if you need these changes.