Expose ctors for setting AdditionalProperties on Hosted tools #7120
+429
−46
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 PR adds constructors to hosted tool classes that accept an IReadOnlyDictionary<string, object?> parameter, enabling users to set additional properties during instantiation. This addresses issues #7115 and #6570 by providing a cleaner API for configuring provider-specific tool properties like ranking options, filters, and image generation settings.
Key Changes:
- Added constructor overloads accepting
additionalPropertiesparameter to all hosted tool classes - Introduced
GetProperty<T>helper method for safe property extraction - Refactored OpenAI conversion logic to use the new helper and support additional properties
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| HostedCodeInterpreterTool.cs | Added constructor accepting additionalProperties and overrode AdditionalProperties property |
| HostedFileSearchTool.cs | Added constructor accepting additionalProperties and overrode AdditionalProperties property |
| HostedWebSearchTool.cs | Added constructor accepting additionalProperties and overrode AdditionalProperties property |
| HostedImageGenerationTool.cs | Added constructor accepting additionalProperties and overrode AdditionalProperties property |
| HostedMcpServerTool.cs | Added constructor overloads (for both string and Uri) accepting additionalProperties and overrode AdditionalProperties property |
| OpenAIClientExtensions.cs | Added GetProperty helper method for safe typed property extraction from AdditionalProperties |
| OpenAIResponsesChatClient.cs | Refactored conversion logic to use GetProperty helper for WebSearchTool, FileSearchTool, and ImageGenerationTool properties |
| OpenAIAssistantsChatClient.cs | Updated FileSearchTool conversion to extract RankingOptions from additional properties |
| HostedCodeInterpreterToolTests.cs | Added tests for new constructor with additionalProperties and null handling |
| HostedFileSearchToolTests.cs | Added tests for new constructor with additionalProperties and null handling |
| HostedWebSearchToolTests.cs | Added tests for new constructor with additionalProperties and null handling |
| HostedImageGenerationToolTests.cs | New test file with tests for constructor, options, and additionalProperties |
| HostedMcpServerToolTests.cs | Added tests for new constructors (string and Uri) with additionalProperties and null handling |
| OpenAIConversionTests.cs | Updated test to use new constructor; added comprehensive tests for FileSearchTool, ImageGenerationTool conversions with additional properties |
| Microsoft.Extensions.AI.Abstractions.json | Updated API baseline for stable hosted tools with new constructors and AdditionalProperties overrides |
ericstj
reviewed
Dec 12, 2025
src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponsesChatClient.cs
Show resolved
Hide resolved
ericstj
reviewed
Dec 12, 2025
src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponsesChatClient.cs
Outdated
Show resolved
Hide resolved
ericstj
reviewed
Dec 12, 2025
src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponsesChatClient.cs
Outdated
Show resolved
Hide resolved
ericstj
reviewed
Dec 12, 2025
src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponsesChatClient.cs
Outdated
Show resolved
Hide resolved
ericstj
approved these changes
Dec 12, 2025
Member
ericstj
left a comment
ericstj
left a comment
There was a problem hiding this comment.
Non-blocking questions / suggestions.
stephentoub
added a commit
to ericstj/extensions
that referenced
this pull request
Dec 12, 2025
…#7120) * Expose ctors for setting AdditionalProperties on Hosted tools * Address feedback
Member
|
We'll always be able to plumb members later, I was thinking if there might be a way to automatically keep them up to date. perhaps a source generator could do so. Might not be worth the effort if it doesn't change often. |
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.
Closes #7115
Closes #6570
Microsoft Reviewers: Open in CodeFlow