Skip to content

[InferenceService] Apply .NET API review model names - #47800

Open
Aayush Kataria (aayush3011) wants to merge 4 commits into
mainfrom
users/akataria/dotnetModelNames
Open

Aayush Kataria (aayush3011) wants to merge 4 commits into
mainfrom
users/akataria/dotnetModelNames

Conversation

@aayush3011

Copy link
Copy Markdown
Member

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Applies .NET API review feedback on Azure.Data.AI model names, C# only, via @@clientName in client.tsp:

  • SemanticRerankingInferenceContent → SemanticRerankingOptions
  • SemanticRerankingMetaResult → SemanticRerankingMetadata
  • SemanticRerankingInferenceResult → SemanticRerankingResult (the response envelope, which .NET doesn't expose, becomes SemanticRerankingOperationResult to free the name)

SemanticRerankingOptions needs one suppression of csharp-model-suffix, since the reviewer asked for the Options suffix for this options-bag request model. "This publishes the change reviewed and merged in the private repo: Azure/azure-rest-api-specs-pr#31092. Other languages are unchanged by the renames.

Also changes targetPaths to string[] with @encode(ArrayEncoding.commaDelimited) per .NET API review, so SDKs expose a string collection while still sending one comma-separated string. This applies to all languages (Python target_paths becomes list[str]). It adds suppressions for known-encoding and unknown-format; the GA OpenAPI keeps type: string and only drops the effectively unbounded maxLength: 2147483647."

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Release planner

A release plan should have been created. If not, please create one as it will help guide you through the REST API and SDK creation process.

Due diligence checklist

  • Authors: I have checked every new or changed TypeSpec suppression (#suppress) in this PR. Each one is needed and has a clear justification that explains why the rule doesn't apply. Suppressions that can be fixed have been removed.
  • Data-plane stewardship reviewers: When typespec-suppressions-review-required is applied, I have reviewed the TypeSpec suppressions and their justifications before applying typespec-suppressions-approved to clear the TypeSpec Suppressions check.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

Getting help

  • First, please carefully read through this PR description, from top to bottom.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

… collection

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ This PR has at least one breaking change (label: BreakingChangeReviewRequired).
    To unblock this PR, follow the process at aka.ms/brch.
  • ❌ The required check named Swagger BreakingChange has failed. To unblock this PR, follow the process at aka.ms/brch.


Comment generated by summarize-checks workflow run.

@github-actions github-actions Bot added the typespec-suppressions-review-required PR reviewer must review all reported typespec suppressions label Oct 30, 2026
@github-actions

github-actions Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

TypeSpec suppressions requiring review

Status: ✅ Approved — 1 suppression

This PR adds or updates the TypeSpec suppressions listed below. Suppressions are strongly discouraged — they bypass linter rules that protect API quality and consistency. Authors should avoid adding new suppressions and prefer fixing the underlying issue; reviewers should approve only when there is a clear, compelling justification and no reasonable alternative. Review each linked rule and source location, then apply typespec-suppressions-approved only if every justification is acceptable. The Status column shows ✅ once the label is applied and ❌ while approval is pending.

New suppressions (1)

StatusRuleSourceJustification
✅@azure-tools/typespec-azure-core/known-encoding
Check for supported encodings.
models.tsp#L55The service contract takes the paths as one comma-separated string; commaDelimited encoding lets SDKs expose a string collection while sending that string.

For an overview of TypeSpec linting rules click here.
For a mapping from ARM lintdiff rules to corresponding TypeSpec linting rules click here.

💬 Have feedback on the TypeSpec suppression flow? Let us know.

@github-actions github-actions Bot added data-plane TypeSpec Authored with TypeSpec BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Oct 30, 2026
@github-actions

github-actions Bot commented Oct 30, 2026 •

Copy link
Copy Markdown

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language API Review for Package
Python azure-data-ai
Java com.azure:azure-data-ai
C# Azure.Data.AI

Comment generated by After APIView workflow run.

@aayush3011
Aayush Kataria (aayush3011) marked this pull request as ready for review October 30, 2026 23:29
@aayush3011 Aayush Kataria (aayush3011) added BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. PublishToCustomers Acknowledgement the changes will be published to Azure customers. typespec-suppressions-approved Apply when new typespec suppressions have been deemed acceptable labels Oct 30, 2026
@azure-sdk-automation azure-sdk-automation Bot removed BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. typespec-suppressions-approved Apply when new typespec suppressions have been deemed acceptable labels Oct 30, 2026
@JoshLove-msft JoshLove-msft added typespec-suppressions-approved Apply when new typespec suppressions have been deemed acceptable data-plane-review-signoff Data-plane API review sign-off/approved: Azure API Stewardship team has signed off and approved. labels Nov 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane data-plane-review-signoff Data-plane API review sign-off/approved: Azure API Stewardship team has signed off and approved. PublishToCustomers Acknowledgement the changes will be published to Azure customers. TypeSpec Authored with TypeSpec typespec-suppressions-approved Apply when new typespec suppressions have been deemed acceptable typespec-suppressions-review-required PR reviewer must review all reported typespec suppressions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants