2024-11-15-preview Congitive Services/Language-Authoring updates #31127

PranshuBansalDev · 2024-10-21T17:00:59Z

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.

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.

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

💬 Teams Channel
💌 email

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

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

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.

openapi-pipeline-app · 2024-10-21T19:56:33Z

Next Steps to Merge

Next steps that must be taken to merge this PR:

❌ This PR has at least one change violating Azure versioning policy (label: VersioningReviewRequired).
To unblock this PR, either a) introduce a new API version with these changes instead of modifying an existing API version, or b) 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.

openapi-pipeline-app · 2024-10-21T19:56:33Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	Language	https://apiview.dev/Assemblies/Review/d940fcb06e874adebca52d9bf9e40221?revisionId=9ef647b4ea9a4ea9a71da5e67d4f1b28
TypeSpec	Language.AnalyzeText-authoring	https://apiview.dev/Assemblies/Review/2a66ca7bd3464c3e85161319bb2c799c?revisionId=58fced3ddaab4bb5b27ca79d23f9d6c6

…ations and Including Test JSON (#3) * - added the additional apis of ExportedModelController to version 2024-11-15-preview - compiled * - added testing jsons for newly added api from ExportedModelController - compiled

openapi-pipeline-app · 2024-10-24T17:49:02Z

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

markcowl

Please set emit-lro-options: "all" in your tspconfig.yaml so we can see the lro properties of your new operations in swagger. Also there is a non-standard PUT that needs review board approval, and soem suggestions for simplifying the naming.

markcowl · 2024-10-24T18:57:37Z

specification/cognitiveservices/Language.AnalyzeText-authoring/models.tsp

+ */
+@added(Versions.v2024_11_15_preview)
+@clientName("DataGenerationConnectionInfo")
+model TextAnalysisAuthoringDataGenerationConnectionInfo {


Why not just call this model DataGenerationConnectionInfo?

markcowl · 2024-10-24T18:58:02Z

specification/cognitiveservices/Language.AnalyzeText-authoring/models.tsp

+ */
+@added(Versions.v2024_11_15_preview)
+@clientName("DataGenerationSettings")
+model TextAnalysisAuthoringDataGenerationSettings {


Why not just call this DataGenerationSettings?

markcowl · 2024-10-24T18:58:53Z

specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp

+@clientName("ExportedTrainedModel", "csharp")
+@resource("exported-models")
+@parentResource(ConversationalAnalysisAuthoringProjectMetadata)
+model ConversationalAnalysisAuthoringExportedTrainedModel {


Why not just call this ExportedTrainedModel?

markcowl · 2024-10-24T18:59:27Z

specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp

+@clientName("ExportedModelJobState", "csharp")
+@resource("jobs")
+@parentResource(ConversationalAnalysisAuthoringExportedTrainedModel)
+model ConversationalAnalysisAuthoringExportedModelJobState {


Same as above, why not simplify the name to mattch the client name?

markcowl · 2024-10-24T19:00:02Z

specification/cognitiveservices/Language.AnalyzeConversations-authoring/models.tsp

+ */
+@clientName("ExportedModelOptions")
+@added(Versions.v2024_11_15_preview)
+model ConversationalAnalysisAuthoringExportedModelOptions {


Same comment on name simplification

markcowl · 2024-10-24T19:01:40Z

specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp

+  @delete
+  @pollingOperation(ConversationalAnalysisAuthoring.getExportedModelJobStatus)
+  @added(Versions.v2024_11_15_preview)
+  deleteExportedModel is Foundations.LongRunningOperation<


Why is this custom operation needed?

markcowl · 2024-10-24T19:02:17Z

specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp

+      @path
+      exportedModelName: string;
+    },
+    AcceptedResponse,


Need to include standard headers like Operation-Location

markcowl · 2024-10-24T19:03:20Z

specification/cognitiveservices/Language.AnalyzeConversations-authoring/routes.tsp

+  @put
+  @pollingOperation(ConversationalAnalysisAuthoring.getExportedModelJobStatus)
+  @added(Versions.v2024_11_15_preview)
+  createOrUpdateExportedModel is Foundations.LongRunningOperation<


This violates the guidelines for LRO PUT operations, has this been approved by the API review Board?

v1 typspec commit

307eb0d

PranshuBansalDev requested a review from yangyuan as a code owner October 21, 2024 17:01

microsoft-github-policy-service bot added the Cognitive Services label Oct 21, 2024

Trying to add the files

651b361

PranshuBansalDev requested review from annatisch, heaths, deyaaeldeen, kristapratico, mssfang, joseharriaga, minhanh-phan and a team as code owners October 21, 2024 19:56

PranshuBansalDev requested review from vicancy and johanste and removed request for a team October 21, 2024 19:56

PranshuBansalDev changed the title ~~v1 typspec commit~~ 2024-11-15-preview Congitive Services/Language-Authoring updates Oct 21, 2024

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane new-api-version TypeSpec Authored with TypeSpec labels Oct 21, 2024

azure-sdk mentioned this pull request Oct 21, 2024

[AutoPR Azure.AI.Language.Authoring.Analyzetext] 2024-11-15-preview Congitive Services/Language-Authoring updates azure-sdk/azure-sdk-for-net#9569

Draft

Pranshu Bansal added 3 commits October 21, 2024 13:13

Add examples

1725e50

Fix more build issues

4928a76

Address build issues

7f11a7b

PranshuBansalDev added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Oct 21, 2024

Pranshu Bansal added 3 commits October 21, 2024 15:37

Mark assignedResources as optional

b444dc1

Fix issue where param was mandatory but its optional

f42b445

Update to fix optional param marked as required

23642cc

Revert mandatory -> optional change

b1b9f88

JeffreyRichter added the BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior label Oct 22, 2024

JeffreyRichter approved these changes Oct 22, 2024

View reviewed changes

mikekistler linked an issue Oct 23, 2024 that may be closed by this pull request

[Language Customization - Custom NER and Custom text classification (CT)] API Review #30326

Open

Merge branch 'main' into pranbansal/authoring-2024-11-15-preview/base

999e5a3

Formatting issues (tsv run)

ca9059a

markcowl requested changes Oct 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2024-11-15-preview Congitive Services/Language-Authoring updates #31127

2024-11-15-preview Congitive Services/Language-Authoring updates #31127

PranshuBansalDev commented Oct 21, 2024

openapi-pipeline-app bot commented Oct 21, 2024 •

edited

Loading

openapi-pipeline-app bot commented Oct 21, 2024 •

edited

Loading

openapi-pipeline-app bot commented Oct 24, 2024

markcowl left a comment

markcowl Oct 24, 2024

markcowl Oct 24, 2024

markcowl Oct 24, 2024

markcowl Oct 24, 2024

markcowl Oct 24, 2024

markcowl Oct 24, 2024

markcowl Oct 24, 2024

markcowl Oct 24, 2024

2024-11-15-preview Congitive Services/Language-Authoring updates #31127

Are you sure you want to change the base?

2024-11-15-preview Congitive Services/Language-Authoring updates #31127

Conversation

PranshuBansalDev commented Oct 21, 2024

Data Plane API Specification Update Pull Request

PR review workflow diagram

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

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

Tooling

Guidelines & Specifications

Helpful Links

Getting help

openapi-pipeline-app bot commented Oct 21, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented Oct 21, 2024 • edited Loading

Generated ApiView

openapi-pipeline-app bot commented Oct 24, 2024

markcowl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

openapi-pipeline-app bot commented Oct 21, 2024 •

edited

Loading

openapi-pipeline-app bot commented Oct 21, 2024 •

edited

Loading