Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 19, 2025

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.

Addresses review feedback from #38821 on incorrect example title. The ContentAnalyzers_DeleteResult.json example incorrectly titled the operation as "Delete Analyzer" when it actually deletes an analysis result, not the analyzer itself.

Changes

  • Updated example title from "Delete Analyzer" to "Delete Analysis Result" in ContentAnalyzers_DeleteResult.json
  • Aligns with naming convention used in ContentAnalyzers_GetResult.json ("Get Analysis Result")
  • Clarifies distinction between deleting an analyzer (ContentAnalyzers_Delete) vs. deleting an analysis result (ContentAnalyzers_DeleteResult)

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.

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: N/A (documentation fix)
  • Previous API Spec Doc: N/A
  • Updated paths: specification/ai/data-plane/ContentUnderstanding/stable/2025-11-01/examples/ContentAnalyzers_DeleteResult.json

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.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: bojunehsu <1988517+bojunehsu@users.noreply.github.com>
Copilot AI changed the title [WIP] Update to address feedback from review on Content Understanding GA PR Fix example title in ContentAnalyzers_DeleteResult.json Nov 19, 2025
Copilot AI requested a review from bojunehsu November 19, 2025 06:37
Copilot finished work on behalf of bojunehsu November 19, 2025 06:37
@bojunehsu bojunehsu marked this pull request as ready for review November 19, 2025 06:37
@bojunehsu bojunehsu merged commit b8cd664 into paulhsu/ContentUnderstanding-2025-11-01 Nov 19, 2025
4 of 11 checks passed
@bojunehsu bojunehsu deleted the copilot/sub-pr-38821 branch November 19, 2025 06:37
@github-actions
Copy link

github-actions bot commented Nov 19, 2025

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Comment generated by summarize-checks workflow run.

bojunehsu added a commit that referenced this pull request Nov 20, 2025
* Initial commit of Content Understanding 2025-11-01 GA

* Migrate the client SDK changes from azure-rest-api-specs-pr (#38839)

* MIGRATE SDK changes from azure-rest-api-specs-pr:

- Updated ContentUnderstandingClient interface to flatten operations and enhance naming conventions.
- Renamed ContentAnalyzer's status field to ResourceStatus for better clarity.
- Introduced StringEncoding union for encoding formats in AnalyzeParameters.
- Adjusted tspconfig.yaml to enable Java support and ensure proper emission of client libraries.

* PYTHON-SDK-FEEDBACK:
Add fieldType and inputRange renaming for clarity in ContentUnderstandingClient

* SDK-PYTHON: Hide string_encoding parameter in Python SDK and clarify string indexing behavior

* Move operation renames into interface definition

* PR Comments:
- Comment out emitters in emit to avoid dependency in this repo
- Move internal def of getRestul and getOperationStatus to client.tsp
- Merge operation rename in interface
- rename createAnalyzer

* Fix incorrect name in listAnalyzers renaming for .NET

* Fix typo in deleteAnalyzer method name in ContentUnderstandingClient interface

* Remove preview versions.  Add examples.

* Fix PR checks

* Fix example title in ContentAnalyzers_DeleteResult.json (#38877)

* Initial plan

* Fix example title: Change "Delete Analyzer" to "Delete Analysis Result"

Co-authored-by: bojunehsu <1988517+bojunehsu@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: bojunehsu <1988517+bojunehsu@users.noreply.github.com>

* Address review feedbacks.

---------

Co-authored-by: Yung-Shin Lin <yslin@microsoft.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: bojunehsu <1988517+bojunehsu@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants