🐛 Bug Report: OpenAI's new SDK types break most of the instrumentation

[dinmukhamedm]

Which component is this bug for?

OpenAI Instrumentation

📜 Description

It looks like OpenAI has rearranged some types in its SDK, making some into Annotated[Union], which breaks some of our

• isinstance checks
• imports
• tests

Opening this for visibility, details to come.

👟 Reproduction steps

1. upgrade to latest openai: uv add -U openai (version 1.99.7)
2. Run the code below

from opentelemetry.instrumentation.openai import OpenAIInstrumentor
OpenAIInstrumentor().instrument()

👍 Expected behavior

It instruments the code

👎 Actual Behavior with Screenshots

Traceback (most recent call last):
  File "/Users/din/sandbox/py/openai_tool.py", line 8, in <module>
    OpenAIInstrumentor().instrument()
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^
  File "/Users/din/sandbox/py/.venv/lib/python3.13/site-packages/opentelemetry/instrumentation/instrumentor.py", line 125, in instrument
    result = self._instrument(  # pylint: disable=assignment-from-no-return
        **kwargs
    )
  File "/Users/din/sandbox/py/.venv/lib/python3.13/site-packages/opentelemetry/instrumentation/openai/__init__.py", line 38, in _instrument
    from opentelemetry.instrumentation.openai.v1 import OpenAIV1Instrumentor
  File "/Users/din/sandbox/py/.venv/lib/python3.13/site-packages/opentelemetry/instrumentation/openai/v1/__init__.py", line 5, in <module>
    from opentelemetry.instrumentation.openai.shared.chat_wrappers import (
    ...<2 lines>...
    )
  File "/Users/din/sandbox/py/.venv/lib/python3.13/site-packages/opentelemetry/instrumentation/openai/shared/chat_wrappers.py", line 53, in <module>
    from openai.types.chat import ChatCompletionMessageToolCall
ImportError: cannot import name 'ChatCompletionMessageToolCall' from 'openai.types.chat' (/Users/din/sandbox/py/.venv/lib/python3.13/site-packages/openai/types/chat/__init__.py)

🤖 Python Version

3.13

📃 Provide any additional context for the Bug.

I think problems start since about 1.99.3

---

I might submit a PR after a bit more investigation, but since this is probably quite time-sensitive, I welcome anyone else to pick this up.

👀 Have you spent some time to check if this bug has been raised before?

• I checked and didn't find similar issue

Are you willing to submit PR?

None

[dinmukhamedm]

The main culprit is this line

https://github.com/traceloop/openllmetry/blob/main/packages/opentelemetry-instrumentation-openai/opentelemetry/instrumentation/openai/shared/chat_wrappers.py#L53

Now OpenAI changes the type from ChatCompletionMessageToolCall to ChatCompletionMessageFunctionToolCall.

The most naive fix is to just replace the type. I think this means that the instrumentation won't recognize the newly added ChatCompletionMessageCustomToolCalls properly, but it's better than not working completely

[dinmukhamedm]

Another type that breaks at least in the tests is this: https://github.com/traceloop/openllmetry/blob/main/packages/opentelemetry-instrumentation-openai/tests/traces/test_chat.py#L8

[nirga]

I think it's a viable fix and we can release a new version immediately. We can potentially guard against this causing an issue with old versions - import it under a try...except.
Thanks for catching!

[dinmukhamedm]

@nirga now that I see the scope of the issue is relatively small, I can work on this. Shall I open a PR?

[nirga]

@dinmukhamedm sure! Thanks :)