ChatCompletionClient.load_component support default-headers

[zhangshan123]

What feature would you like to be added?

ChatCompletionClient.load_component support default-headers

Why is this needed?

When I use AzureOpenAIChatCompletionClient and pass the below parameters, the code is working fine,
model_client = AzureOpenAIChatCompletionClient(
model = "gpt-4o-2024-05-13",
azure_deployment= 'xxxxxx',
azure_endpoint = 'xxxxxx',
api_version = 'xxxx',
api_key = os.getenv("AZURE_API_KEY"),
default_headers = {'X-User-Id': os.getlogin()}
)
but when I use ChatCompletionClient.load_component, and pass the config:
{'provider': 'AzureOpenAIChatCompletionClient', 'config': {'model': 'xxxxx', 'azure_endpoint': 'xxxx', 'azure_deployment': 'xxxxx', 'api_version': 'xxxx', 'api_key': 'xxxxx', 'default_headers': {'X-User-Id': 'xxxxxx'}}}
it seems there is no way can pass the default_headers property, so meet the below error:
openai.PermissionDeniedError: Error code: 403 - {'error': {'code': '403', 'message': 'The X-User-Id request header is now mandatory for cost allocation. Please set the parameter with "xxxxx" for allocating to the end user's department or "srv_xxxx" for background jobs.'}}

[zhangshan123]

When I add default_headers property in AzureOpenAIClientConfigurationConfigModel, it can work fine.
class AzureOpenAIClientConfigurationConfigModel(BaseOpenAIClientConfigurationConfigModel):
# Azure specific
azure_endpoint: str
azure_deployment: str | None = None
api_version: str
azure_ad_token: str | None = None
azure_ad_token_provider: ComponentModel | None = None
default_headers: dict | None = None

[ekzhu]

Would you like to submit a PR to fix this? The default header property is currently not part of the serialized config.

We need to modify this:

autogen/python/packages/autogen-ext/src/autogen_ext/models/openai/config/__init__.py

Lines 70 to 71 in 1982f1b

	class BaseOpenAIClientConfigurationConfigModel(CreateArgumentsConfigModel):
	model: str

to include default_headers