Fix OpenAIEmbeddingGenerator to handle missing usage data #7074
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
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request fixes a bug in OpenAIEmbeddingGenerator where missing or null usage data in the OpenAI API response would cause a NullReferenceException. The fix adds a null check before accessing usage properties and includes comprehensive test coverage for both scenarios.
- Added null-safe handling of
embeddings.Usageto prevent crashes when usage data is absent - Added two test cases covering missing and explicitly null usage fields in API responses
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIEmbeddingGenerator.cs | Added null check for embeddings.Usage before accessing its properties, returning null UsageDetails when usage data is unavailable |
| test/Libraries/Microsoft.Extensions.AI.OpenAI.Tests/OpenAIEmbeddingGeneratorTests.cs | Added tests for missing usage field and explicitly null usage field scenarios |
eiriktsarpalis
approved these changes
Nov 21, 2025
stephentoub
added a commit
to jeffhandley/extensions
that referenced
this pull request
Nov 21, 2025
jeffhandley
pushed a commit
that referenced
this pull request
Nov 21, 2025
This was referenced Dec 11, 2025
This was referenced Dec 11, 2025
Merged
Open
Open
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Fixes #7070
Microsoft Reviewers: Open in CodeFlow