feat: Add v1 OpenAI endpoint support and remove legacy completions API by ranadeepsingh · Pull Request #2560 · microsoft/SynapseML

ranadeepsingh · 2026-05-08T19:46:36Z

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

This PR updates SynapseML OpenAI integrations to support OpenAI v1-compatible base URLs such as:

https://<resource_name>.services.ai.azure.com/openai/v1

Changes include:

Adds v1 base URL detection and request URL construction for OpenAI chat completions, embeddings, responses, and OpenAIPrompt.
For v1 endpoints, sends the deployment/model as the request body model field and omits the api-version query parameter.
Preserves existing Azure OpenAI endpoint behavior for non-v1 URLs, including deployment-scoped paths and api-version.
Emits a warning when users configure a v1 base URL together with apiVersion, since apiVersion is ignored for v1-style endpoints.
Removes the deprecated/retired legacy OpenAICompletion API implementation, response schema, and tests.
Updates current OpenAI docs/notebooks and docgen metadata to remove legacy completion usage and point users to OpenAIChatCompletion, OpenAIPrompt, and OpenAIResponses.

How is this patch tested?

I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works.

Tested with the synapseml conda environment:

conda run -n synapseml black --check --extend-exclude 'docs/' .
conda run -n synapseml sbt "cognitive / Test / compile"
conda run -n synapseml sbt "cognitive / Test / testOnly com.microsoft.azure.synapse.ml.services.openai.OpenAIV1EndpointSuite"
conda run -n synapseml sbt scalastyle test:scalastyle
git diff --check

Note: sbt scalafmtCheckAll was attempted but this build does not define that sbt task.

Does this PR change any dependencies?

No. You can skip this section.
Yes. Make sure the dependencies are resolved correctly, and list changes here.

Does this PR add a new feature? If so, have you added samples on website?

No. You can skip this section.
Yes. Make sure you have added samples following below steps.

This adds support for OpenAI v1-compatible base URLs. Current OpenAI notebooks/docs were updated to remove retired OpenAICompletion examples and describe supported chat, responses, and embedding APIs.

github-actions · 2026-05-08T19:46:47Z

Hey @ranadeepsingh 👋!
Thank you so much for contributing to our repository 🙌.
Someone from SynapseML Team will be reviewing this pull request soon.

We use semantic commit messages to streamline the release process.
Before your pull request can be merged, you should make sure your first commit and PR title start with a semantic prefix.
This helps us to create release messages and credit you for your hard work!

Examples of commit messages with semantic prefixes:

fix: Fix LightGBM crashes with empty partitions
feat: Make HTTP on Spark back-offs configurable
docs: Update Spark Serving usage
build: Add codecov support
perf: improve LightGBM memory usage
refactor: make python code generation rely on classes
style: Remove nulls from CNTKModel
test: Add test coverage for CNTKModel

To test your commit locally, please follow our guild on building from source.
Check out the developer guide for additional guidance on testing your change.

ranadeepsingh · 2026-05-08T19:47:07Z

/azp run

azure-pipelines · 2026-05-08T19:47:18Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

codecov-commenter · 2026-05-08T20:01:14Z

Codecov Report

❌ Patch coverage is 98.36066% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 84.78%. Comparing base (71e8e6d) to head (97ac819).

Files with missing lines	Patch %	Lines
...soft/azure/synapse/ml/services/openai/OpenAI.scala	95.23%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2560      +/-   ##
==========================================
+ Coverage   84.69%   84.78%   +0.08%     
==========================================
  Files         335      334       -1     
  Lines       17753    17756       +3     
  Branches     1615     1634      +19     
==========================================
+ Hits        15036    15054      +18     
+ Misses       2717     2702      -15

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

ranadeepsingh · 2026-05-09T01:07:34Z

/azp run

azure-pipelines · 2026-05-09T01:07:45Z

Azure Pipelines successfully started running 1 pipeline(s).

ranadeepsingh · 2026-05-09T01:31:46Z

/azp run

azure-pipelines · 2026-05-09T01:31:57Z

Azure Pipelines successfully started running 1 pipeline(s).

ranadeepsingh · 2026-05-09T08:59:16Z

/azp run

azure-pipelines · 2026-05-09T08:59:27Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Copilot

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

ranadeepsingh · 2026-05-19T08:23:21Z

/azp run

azure-pipelines · 2026-05-19T08:23:34Z

Azure Pipelines successfully started running 1 pipeline(s).

ranadeepsingh · 2026-05-19T09:45:42Z

/azp run

azure-pipelines · 2026-05-19T09:45:55Z

Azure Pipelines successfully started running 1 pipeline(s).

This reverts commit fa708e2.

This reverts commit 3ed6044.

This reverts commit 9a40c5c.

ranadeepsingh · 2026-05-19T10:07:25Z

/azp run

azure-pipelines · 2026-05-19T10:07:37Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Copilot encountered an error: Your billing is not configured or you have Copilot licenses from multiple standalone organizations or enterprises. To use premium requests, select a billing entity via the GitHub site, under Settings > Copilot > Features.

Copilot

Copilot's findings

Files reviewed: 16/16 changed files
Comments generated: 0 new

This reverts commit 987484c.

This reverts commit f06f1ad.

This reverts commit 10715cd.

ranadeepsingh · 2026-05-19T10:24:05Z

/azp run

azure-pipelines · 2026-05-19T10:24:16Z

Azure Pipelines successfully started running 1 pipeline(s).

ranadeepsingh · 2026-05-19T17:59:34Z

/azp run

azure-pipelines · 2026-05-19T17:59:46Z

Azure Pipelines successfully started running 1 pipeline(s).

BrendanWalsh

Looks good from my review.

Add v1 OpenAI Endpoint support and remove legacy completions API

2998fbc

Copilot AI review requested due to automatic review settings May 8, 2026 19:46

Copilot started reviewing on behalf of ranadeepsingh May 8, 2026 19:47 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

Fix FuzzingUnitTest

aea26ca

Add test to increase code coverage

60c6f7a

Make v1 api assumption cleaner

ce41a33

ranadeepsingh requested review from BrendanWalsh and Copilot May 9, 2026 13:15

Copilot started reviewing on behalf of ranadeepsingh May 9, 2026 13:16 View session

Copilot AI reviewed May 9, 2026

View reviewed changes

ranadeepsingh requested a review from Copilot May 9, 2026 13:30

Copilot started reviewing on behalf of ranadeepsingh May 9, 2026 13:31 View session

Copilot AI reviewed May 9, 2026

View reviewed changes

ranadeepsingh added 2 commits May 18, 2026 23:47

Add OpenAICompletion deprecation

fa708e2

Remove deprecation warnings

9a40c5c

Fix RAI test for OpenAIPrompt

3ed6044

ranadeepsingh added 3 commits May 19, 2026 03:06

Revert "Add OpenAICompletion deprecation"

10715cd

This reverts commit fa708e2.

Revert "Fix RAI test for OpenAIPrompt"

f06f1ad

This reverts commit 3ed6044.

Revert "Remove deprecation warnings"

987484c

This reverts commit 9a40c5c.

ranadeepsingh requested a review from Copilot May 19, 2026 10:08

Copilot AI reviewed May 19, 2026

View reviewed changes

ranadeepsingh requested a review from Copilot May 19, 2026 10:10

Copilot started reviewing on behalf of ranadeepsingh May 19, 2026 10:10 View session

Copilot AI reviewed May 19, 2026

View reviewed changes

ranadeepsingh added 3 commits May 19, 2026 03:23

Reapply "Remove deprecation warnings"

59226ac

This reverts commit 987484c.

Reapply "Fix RAI test for OpenAIPrompt"

867c980

This reverts commit f06f1ad.

Reapply "Add OpenAICompletion deprecation"

97ac819

This reverts commit 10715cd.

BrendanWalsh approved these changes May 20, 2026

View reviewed changes

BrendanWalsh changed the title ~~feat: Add v1 OpenAI Endpoint support and remove legacy completions API~~ feat: Add v1 OpenAI endpoint support and remove legacy completions API May 20, 2026

BrendanWalsh merged commit 30cda27 into microsoft:master May 20, 2026
81 checks passed

Conversation

ranadeepsingh commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related Issues/PRs

What changes are proposed in this pull request?

How is this patch tested?

Does this PR change any dependencies?

Does this PR add a new feature? If so, have you added samples on website?

Uh oh!

github-actions Bot commented May 8, 2026

Uh oh!

ranadeepsingh commented May 8, 2026

Uh oh!

azure-pipelines Bot commented May 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ranadeepsingh commented May 9, 2026

Uh oh!

azure-pipelines Bot commented May 9, 2026

Uh oh!

ranadeepsingh commented May 9, 2026

Uh oh!

azure-pipelines Bot commented May 9, 2026

Uh oh!

ranadeepsingh commented May 9, 2026

Uh oh!

azure-pipelines Bot commented May 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

ranadeepsingh commented May 19, 2026

Uh oh!

azure-pipelines Bot commented May 19, 2026

Uh oh!

ranadeepsingh commented May 19, 2026

Uh oh!

azure-pipelines Bot commented May 19, 2026

Uh oh!

ranadeepsingh commented May 19, 2026

Uh oh!

azure-pipelines Bot commented May 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot's findings

Uh oh!

ranadeepsingh commented May 19, 2026

Uh oh!

azure-pipelines Bot commented May 19, 2026

Uh oh!

ranadeepsingh commented May 19, 2026

Uh oh!

azure-pipelines Bot commented May 19, 2026

Uh oh!

BrendanWalsh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ranadeepsingh commented May 8, 2026 •

edited

Loading

codecov-commenter commented May 8, 2026 •

edited

Loading