fix(request-model): Add check for the model attr in request object in openaiv2 #4017
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lmolkova
reviewed
Dec 9, 2025
...opentelemetry-instrumentation-openai-v2/src/opentelemetry/instrumentation/openai_v2/patch.py
Show resolved
Hide resolved
punitmahes
changed the title
xrmx
reviewed
Dec 10, 2025
instrumentation-genai/opentelemetry-instrumentation-openai-v2/tests/test_chat_completions.py
Outdated
Show resolved
Hide resolved
Contributor
|
@punitmahes Thanks for the PR, looks like some of the commits are done under a different name. Please fix the git history so that all commits are covered by the CLA |
Contributor
Author
|
@xrmx Done |
lmolkova
approved these changes
Dec 10, 2025
xrmx
approved these changes
Dec 11, 2025
Contributor
xrmx
left a comment
xrmx
left a comment
There was a problem hiding this comment.
Please add an entry inside the instrumentation CHANGELOG
xrmx
reviewed
Dec 11, 2025
instrumentation-genai/opentelemetry-instrumentation-openai-v2/CHANGELOG.md
Show resolved
Hide resolved
github-project-automation
bot
moved this from Approved PRs that need fixes
to Done
in @xrmx's Python PR digest
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes an AttributeError that occurs when using the OpenAI client with with_raw_response. In this scenario, the result object returned is a LegacyAPIResponse which does not directly expose attributes like .model or .choices, causing the instrumentation to crash when attempting to set span attributes or record metrics.
Changes implemented:
Response Parsing: Added logic to detect if the result has a .parse() method (indicative of LegacyAPIResponse). If present, it calls .parse() to retrieve the actual response object containing the necessary attributes (model, choices, etc.).
Safe Attribute Access: Updated _set_response_attributes to use getattr for safer access to .model to prevent future AttributeErrors.
Fixes #4002
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
I have added new unit tests specifically for the with_raw_response flow for both synchronous and asynchronous clients, using VCR cassettes to mock the OpenAI API interaction.
Does This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.