Allow headers override instead of just ua #1787
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
Codex Review: Here are some suggestions.
Reply with @codex fix comments to fix any unresolved comments.
About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you open a pull request for review, mark a draft as ready, or comment "@codex review". If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex fix this CI failure" or "@codex address that feedback".
| _USER_AGENT = f"Agents/Python {__version__}" | ||
| HEADERS = {"User-Agent": _USER_AGENT} | ||
|
|
||
| USER_AGENT_OVERRIDE: ContextVar[str | None] = ContextVar( | ||
| "openai_chatcompletions_user_agent_override", default=None | ||
| HEADERS_OVERRIDE: ContextVar[dict[str, str] | None] = ContextVar( | ||
| "openai_chatcompletions_headers_override", default=None | ||
| ) |
There was a problem hiding this comment.
[P1] Preserve USER_AGENT_OVERRIDE for backward compatibility
The context variable used by external callers to override the chat-completions User-Agent was renamed from USER_AGENT_OVERRIDE to HEADERS_OVERRIDE with no alias left behind. Because the original name was public (no leading underscore) and tests imported it directly, any existing client code that still does from agents.models.chatcmpl_helpers import USER_AGENT_OVERRIDE will now raise ImportError/AttributeError and lose the ability to override headers. Consider keeping the old symbol as an alias (USER_AGENT_OVERRIDE = HEADERS_OVERRIDE) or deprecating it gradually to avoid an unnecessary breaking change.
Useful? React with 👍 / 👎.
Update the user agent override context var to override headers generally instead of just the ua header. This allows us to pass in rich header info from other OA sdks running alongside Agents SDK.