Repository navigation
[InferenceService] Apply .NET API review model names - #47800
Aayush Kataria (aayush3011) wants to merge 4 commits into
Conversation
… collection Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Next Steps to MergeNext steps that must be taken to merge this PR:
Comment generated by summarize-checks workflow run. |
TypeSpec suppressions requiring reviewStatus: ✅ 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 New suppressions (1)
For an overview of TypeSpec linting rules click here. 💬 Have feedback on the TypeSpec suppression flow? Let us know. |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews
Comment generated by After APIView workflow run. |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Data Plane API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.Applies .NET API review feedback on Azure.Data.AI model names, C# only, via
@@clientNameinclient.tsp:SemanticRerankingInferenceContent→SemanticRerankingOptionsSemanticRerankingMetaResult→SemanticRerankingMetadataSemanticRerankingInferenceResult→SemanticRerankingResult(the response envelope, which .NET doesn't expose, becomesSemanticRerankingOperationResultto free the name)SemanticRerankingOptionsneeds one suppression ofcsharp-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
targetPathstostring[]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 (Pythontarget_pathsbecomeslist[str]). It adds suppressions forknown-encodingandunknown-format; the GA OpenAPI keepstype: stringand only drops the effectively unboundedmaxLength: 2147483647."PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
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.
Is this review for (select one):
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 ApiViewcomment 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
#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.typespec-suppressions-review-requiredis applied, I have reviewed the TypeSpec suppressions and their justifications before applyingtypespec-suppressions-approvedto clear theTypeSpec Suppressionscheck.❔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
write accessper aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.