Skip to content

A programming framework for agentic AI

Add default_header support (#5249)

Nour Bouzid0bf786fbb6b2
diff --git a/python/packages/autogen-ext/src/autogen_ext/models/openai/_openai_client.py b/python/packages/autogen-ext/src/autogen_ext/models/openai/_openai_client.py
index ca652d658..e973862df 100644
--- a/python/packages/autogen-ext/src/autogen_ext/models/openai/_openai_client.py
+++ b/python/packages/autogen-ext/src/autogen_ext/models/openai/_openai_client.py
@@ -982,6 +982,7 @@ class OpenAIChatCompletionClient(BaseOpenAIChatCompletionClient, Component[OpenA
temperature (optional, float):
top_p (optional, float):
user (optional, str):
+ default_headers (optional, dict[str, str]): Custom headers; useful for authentication or other custom requirements.
To use this client, you must install the `openai` extension:
@@ -1116,6 +1117,8 @@ class AzureOpenAIChatCompletionClient(
temperature (optional, float):
top_p (optional, float):
user (optional, str):
+ default_headers (optional, dict[str, str]): Custom headers; useful for authentication or other custom requirements.
+
To use this client, you must install the `azure` and `openai` extensions:
diff --git a/python/packages/autogen-ext/src/autogen_ext/models/openai/config/__init__.py b/python/packages/autogen-ext/src/autogen_ext/models/openai/config/__init__.py
index a6b484780..367564187 100644
--- a/python/packages/autogen-ext/src/autogen_ext/models/openai/config/__init__.py
+++ b/python/packages/autogen-ext/src/autogen_ext/models/openai/config/__init__.py
@@ -35,6 +35,7 @@ class BaseOpenAIClientConfiguration(CreateArguments, total=False):
model_capabilities: ModelCapabilities # type: ignore
model_info: ModelInfo
"""What functionality the model supports, determined by default from model name but is overriden if value passed."""
+ default_headers: Dict[str, str] | None
# See OpenAI docs for explanation of these parameters
@@ -74,6 +75,7 @@ class BaseOpenAIClientConfigurationConfigModel(CreateArgumentsConfigModel):
max_retries: int | None = None
model_capabilities: ModelCapabilities | None = None # type: ignore
model_info: ModelInfo | None = None
+ default_headers: Dict[str, str] | None = None
# See OpenAI docs for explanation of these parameters