[PR] [docs] Use a current GA API version in the Azure OpenAI examples [flink-agents]

["weiqingy (via GitHub)" <gi...@apache.org>]

weiqingy opened a new pull request, #935:
URL: https://github.com/apache/flink-agents/pull/935

   Linked issue: #280
   
   ### Purpose of change
   
   The Azure OpenAI documentation used `2024-02-15-preview` in the Python parameter table and example, and `2024-02-01` in the Java ones. Both are early-2024 versions, and the two languages disagreed with each other for no particular reason.
   
   This uses `2024-10-21` in all four places. That is the most recent stable version listed in the `AzureOpenAIServiceVersion` enum of the `openai-java` SDK 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-preview` and later, so a user who copies the current example and then passes an `output_schema` gets 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-needed`
   - [ ] `doc-not-needed`
   - [x] `doc-included`
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] [docs] Use a current GA API version in the Azure OpenAI examples [flink-agents]

["wenjin272 (via GitHub)" <gi...@apache.org>]

wenjin272 merged PR #935:
URL: https://github.com/apache/flink-agents/pull/935


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org