-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
2024-11-15-preview Congitive Services/Language-Authoring updates #31127
base: main
Are you sure you want to change the base?
2024-11-15-preview Congitive Services/Language-Authoring updates #31127
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Generated ApiView
|
…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
PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
*/ | ||
@added(Versions.v2024_11_15_preview) | ||
@clientName("DataGenerationConnectionInfo") | ||
model TextAnalysisAuthoringDataGenerationConnectionInfo { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not just call this model DataGenerationConnectionInfo?
*/ | ||
@added(Versions.v2024_11_15_preview) | ||
@clientName("DataGenerationSettings") | ||
model TextAnalysisAuthoringDataGenerationSettings { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not just call this DataGenerationSettings?
@clientName("ExportedTrainedModel", "csharp") | ||
@resource("exported-models") | ||
@parentResource(ConversationalAnalysisAuthoringProjectMetadata) | ||
model ConversationalAnalysisAuthoringExportedTrainedModel { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not just call this ExportedTrainedModel?
@clientName("ExportedModelJobState", "csharp") | ||
@resource("jobs") | ||
@parentResource(ConversationalAnalysisAuthoringExportedTrainedModel) | ||
model ConversationalAnalysisAuthoringExportedModelJobState { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above, why not simplify the name to mattch the client name?
*/ | ||
@clientName("ExportedModelOptions") | ||
@added(Versions.v2024_11_15_preview) | ||
model ConversationalAnalysisAuthoringExportedModelOptions { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment on name simplification
@delete | ||
@pollingOperation(ConversationalAnalysisAuthoring.getExportedModelJobStatus) | ||
@added(Versions.v2024_11_15_preview) | ||
deleteExportedModel is Foundations.LongRunningOperation< |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this custom operation needed?
@path | ||
exportedModelName: string; | ||
}, | ||
AcceptedResponse, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to include standard headers like Operation-Location
@put | ||
@pollingOperation(ConversationalAnalysisAuthoring.getExportedModelJobStatus) | ||
@added(Versions.v2024_11_15_preview) | ||
createOrUpdateExportedModel is Foundations.LongRunningOperation< |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This violates the guidelines for LRO PUT operations, has this been approved by the API review Board?
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.
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 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.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
Getting help
write access
per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositoriesNext 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.and https://aka.ms/ci-fix.
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.