[docs] Use a current GA API version in the Azure OpenAI examples - #935
Merged
Conversation
The Azure OpenAI parameter tables and examples used 2024-02-15-preview on the Python side and 2024-02-01 on the Java side. Both are early-2024 versions, and the two languages disagreed for no reason. Use 2024-10-21 in all four places. It is the most recent stable version in the AzureOpenAIServiceVersion enum of the openai-java SDK this project already depends on, so an example that names it stays consistent with what the client supports.
github-actions
Bot
added
doc-included
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
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.
Linked issue: #280
Purpose of change
The Azure OpenAI documentation used
2024-02-15-previewin the Python parameter table and example, and2024-02-01in the Java ones. Both are early-2024 versions, and the two languages disagreed with each other for no particular reason.This uses
2024-10-21in all four places. That is the most recent stable version listed in theAzureOpenAIServiceVersionenum of theopenai-javaSDK this project already depends on, so a documented example stays consistent with what the client actually supports.There is a second reason to prefer a newer version here. Azure gates structured outputs on api-version
2024-08-01-previewand later, so a user who copies the current example and then passes anoutput_schemagets the prompt-engineering fallback rather than the provider's native path, with nothing indicating why. That was harmless while nothing read the api-version, and becomes a papercut with the native structured-output work in #919 and #930.Documenting which providers support native structured output is a separate change and is not included here, since that work is still in review.
Tests
Not applicable, documentation only. No code or example semantics change beyond the version string; the four sites are the two parameter tables and the two connection examples.
API
No.
Documentation
doc-neededdoc-not-neededdoc-included