Repository navigation
[docs] Correct the documented provider for the azure YAML alias - #963
Merged
Merged
Conversation
The yaml.md alias table listed the java-side azure alias as Azure OpenAI, but Aliases.java resolves it to AzureAIChatModelConnection, which targets the Azure AI Inference API rather than Azure OpenAI. A user following the table got a different service with no error. Point the row at Azure AI, matching the section name used in chat_models.md. Behavior is unchanged.
1 task done
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Linked issue: #958
Purpose of change
The
clazz:alias table inyaml.mdlists the java-sideazurealias as resolving to Azure OpenAI:type: pythontype: javaazureThe code resolves it elsewhere.
Aliases.java:89:and
AZURE_CONNECTIONis the Azure AI Inference connection (ResourceName.java:57-58):These are two different integrations against two different services.
AzureAIChatModelConnectionbuilds oncom.azure.ai.inferenceand reaches models deployed through Azure AI Studio, whileAzureOpenAIChatModelConnectionlives in theopenaipackage and targets Azure OpenAI deployments.chat_models.md:402already draws that distinction explicitly for readers of the provider docs.So a user who follows the alias table and writes
clazz: azureexpecting Azure OpenAI silently gets a different service, with no error to point at the mistake.This points the row at Azure AI, which is the name
chat_models.md:393uses for that provider section. Theazurealias itself is unchanged, so nothing breaks for anyone already using it, and the Python side needs no change becausealiases.pyalready mirrors the Java mapping faithfully. This is a documentation correction only.Scope: this is item 2 of #958. Item 1, the six implementations that have no alias at all, is handled separately in #962, which is why this is not marked as closing the issue. #962 touches the
azure_openairow directly above this one, so whichever merges second may need a trivial rebase of that hunk.One thing worth a maintainer's view, though it is not required for this change: the class
azurecurrently resolves to is the subject of #931, whose SDK retires on 2026-08-26. If that integration is removed or replaced, theazurealias needs a decision rather than a doc edit, and that decision is better made once, there.Tests
No tests. The change is a single documentation table cell and touches no code path.
Verified by reading the resolution chain at
main:yaml.md:532→Aliases.java:89→ResourceName.java:57-58→AzureAIChatModelConnection, and confirmingaliases.py:75resolves the same java-bucket alias to the same class throughresource.py:276, so the two languages already agree with each other and only the documentation was out of step.API
No. No public API signature or behavior changes. Alias resolution is untouched.
Documentation
doc-neededdoc-not-neededdoc-included