Skip to content

ContentUndertanding Client SDK Updates#39021

Open
yungshinlintw wants to merge 48 commits intomainfrom
yslin/net_sdk_update
Open

ContentUndertanding Client SDK Updates#39021
yungshinlintw wants to merge 48 commits intomainfrom
yslin/net_sdk_update

Conversation

@yungshinlintw
Copy link
Member

  • Per C# SDK Review and CI C# rules, changing ContentCategoryDefinition to be ContentCategory
  • Fixed an incorrect TypeSpec where SupportedModels should returns an array of GPT models, rather than a dictionary.

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.

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.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

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.

❔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.

@github-actions
Copy link

github-actions bot commented Dec 2, 2025

Next Steps to Merge

⌛ Please wait. Next steps to merge this PR are being evaluated by automation. ⌛

Comment generated by summarize-checks workflow run.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR makes two focused improvements to the ContentUnderstanding TypeSpec specification: correcting the data structure for supported models and standardizing client-side naming.

Key Changes:

  • Fixed SupportedModels to use string[] instead of Record<string> for completion and embedding models, correctly representing an array of model names rather than a dictionary
  • Added client-side renaming of ContentCategoryDefinition to ContentCategory to resolve .NET analyzer warnings (AZC0031) and maintain consistency across all SDK languages

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
specification/ai/ContentUnderstanding/models.tsp Corrects the type definition of SupportedModels.completion and SupportedModels.embedding from dictionaries to string arrays
specification/ai/ContentUnderstanding/client.tsp Adds @@clientName decorator to rename ContentCategoryDefinition to ContentCategory in generated SDKs for all languages

@github-actions
Copy link

github-actions bot commented Dec 2, 2025

API Change Check

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

Language API Review for Package
TypeSpec ContentUnderstanding
Java com.azure:azure-ai-contentunderstanding
Python azure-ai-contentunderstanding

@github-actions github-actions bot added data-plane BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Dec 10, 2025
@microsoft-github-policy-service microsoft-github-policy-service bot added no-recent-activity There has been no recent activity on this issue. and removed no-recent-activity There has been no recent activity on this issue. labels Dec 29, 2025
@yungshinlintw yungshinlintw added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Jan 8, 2026
@yungshinlintw yungshinlintw changed the title Client SDK renaming and also fix incorrect TypeSpec for SupportedModels ContentUndertanding Client SDK Updates Feb 5, 2026
@yungshinlintw yungshinlintw added the BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior label Feb 13, 2026
@yungshinlintw yungshinlintw removed the BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior label Feb 13, 2026
@yungshinlintw yungshinlintw added BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374 labels Feb 13, 2026
@yungshinlintw yungshinlintw enabled auto-merge (squash) February 16, 2026 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane PublishToCustomers Acknowledgement the changes will be published to Azure customers. TypeSpec Authored with TypeSpec Versioning-Approved-BugFix https://github.com/Azure/azure-sdk-tools/issues/6374

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants