Add CreateResult.request_id field for tracking model usage.

[tongyu0924]

Why are these changes needed?

Related issue number

Closes #6049

Checks

• I've included any doc changes needed for https://microsoft.github.io/autogen/. See https://github.com/microsoft/autogen/blob/main/CONTRIBUTING.md 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.

[tongyu0924]

@tongyu0924 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

agree

[ekzhu]

Thanks for the PR, though I would like to hold on a bit before the questions are resolved: #6049 (comment)

[abhinav-aegis]

A minor (semantic) technicality, but at least in both Open AI client and Anthropic, the id is generated by the LLM API and is not created at the time of the request. It is a response ID (which can be used to track what an LLM said in response to a request. One could theoretically track a request ID separately if needed.

[a-holm]

Thanks for adding the request_id field for better tracking! This is a useful addition.

Overall, the approach of adding the optional field to CreateResult and using safe extraction methods (getattr, .get) in the clients looks good.

However, there are two issues I found during review:

1. Azure AI Client (create_stream): The logic to extract request_id in autogen_ext/models/azure/_azure_ai_client.py within the create_stream method appears incorrect. It attempts getattr(result, "request_id", None) where result is the CreateResult being constructed, not the Azure SDK response object. This needs to be revised to correctly fetch the ID from the appropriate SDK object (perhaps stored from an initial response or a chunk if available).
2. Replay Client: The logic in autogen_ext/models/replay/_replay_chat_completion_client.py only extracts request_id if the replayed item is a dict. It should MAYBE if point 1 is on purpose also handle the case where the item is a CreateResult object, potentially using getattr(response, "request_id", None) in that scenario.