Use "Tool" or "PreviewTool" as a suffix for Azure Tools #39477
Conversation
Next Steps to MergeImportant checks have failed. As of today they are not blocking this PR, but in near future they may.Addressing the following failures is highly recommended:
Comment generated by summarize-checks workflow run. |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews
|
| * The input definition information for a Microsoft Fabric tool as used to configure an agent. | ||
| */ | ||
| model MicrosoftFabricAgentTool extends OpenAI.Tool { | ||
| model MicrosoftFabricTool extends OpenAI.Tool { |
There was a problem hiding this comment.
We should consider whether we want to align and specialize the name with the updated discriminator value, e.g. here using MicrosoftFabricPreviewTool. This is what OpenAI ended up doing in having parallel WebSearchTool (web_search) and WebSearchPreviewTool (web_search_preview) components.
The disadvantages are that it's clunky and overall a bit weird; the advantages stem from it cleanly supporting concurrent/overlapping support that may include divergent breaking changes between preview and non-preview tool iterations. I'm in favor of aligning but that's a loosely held answer to a still-open question.
…pdate-azure-tool-names
| @removed(Versions.v1) | ||
| custom_search_configuration?: WebSearchConfiguration; | ||
| custom_search_configuration?: WebSearchConfiguration, | ||
| } |
There was a problem hiding this comment.
The above changes are unrelated to this PR. These are a result of the formatter in "npx tsv ." fixing the format from a previous commit to branch.
dargilco
changed the title
dargilco
changed the title
To align with OpenAI naming conventions, use "Tool" suffix for stable Azure tools:
AzureAISearchAgentToolrenamed toAzureAISearchToolOpenApiAgentTool==>OpenApiToolAzureFunctionAgentTool==>AzureFunctionToolAnd use "PreviewTool" as suffix for Azure tools in preview:
SharepointAgentTool==>SharepointPreviewToolBingCustomSearchAgentTool==>BingCustomSearchPreviewToolBrowserAutomationAgentTool==>BrowserAutomationPreviewToolA2ATool==>A2APreviewToolStill waiting on a call regarding renaming
MemorySearchTool.Also fix some of the doc string for 'type', as it seems like these were not updated when the "_preview" suffix was added to the type string.
This is not a breaking change in REST APIs. This will be a breaking change in emitted beta SDKs, and we will update samples and docs accordingly.