-
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
Add Language authoring 2022-05-01 APIs #18694
Add Language authoring 2022-05-01 APIs #18694
Conversation
Hi, @moabba Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
Guid used in model definition 'ConversationalAnalysisAuthoringExportedLuisOrchestration' for property 'appId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Language/stable/2022-05-01/analyzeconversations-authoring.json#L1824 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 1 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.3)
- current:stable/2022-05-01/common.json compared with base:stable/2021-10-01/common.json
- current:stable/2022-05-01/common.json compared with base:preview/2022-03-01-preview/common.json
Rule | Message |
---|---|
1034 - AddedRequiredProperty |
The new version has new required property 'error' that was not found in the old version. New: Language/stable/2022-05-01/common.json#L10:5 Old: Language/stable/2021-10-01/common.json#L10:5 |
️️✔️
SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi @moabba, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This PR is still pending the examples. |
This reverts commit 455762d.
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.
Comments are largely the same across both swaggers. Overall, though, I'm concerned we haven't previewed these yet and are planning to go GA already.
...cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json
Outdated
Show resolved
Hide resolved
...cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json
Outdated
Show resolved
Hide resolved
...cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json
Outdated
Show resolved
Hide resolved
...cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json
Outdated
Show resolved
Hide resolved
...cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json
Outdated
Show resolved
Hide resolved
specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json
Outdated
Show resolved
Hide resolved
specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json
Outdated
Show resolved
Hide resolved
specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json
Outdated
Show resolved
Hide resolved
specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json
Outdated
Show resolved
Hide resolved
}, | ||
"x-ms-client-name": "CreateDeploymentOptions" | ||
}, | ||
"ConversationalAnalysisAuthoringCreateProjectOptions": { |
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 is really the same as ConversationalAnalysisAuthoringProjectMetadata
and should be "folded" into a single model with readOnly
properties. Unless I'm missing something?
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.
Never mind, I was missing something. There is a difference in requiredness between the create and read models - which, in turn, is due to the use of PATCH for upsert.
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.
Actually, you're right. They are the same, except for the "DateTime" properties (E.g. lastModifiedDateTime
). In the PATCH body, the properties are marked "required" assuming that it's a Create request (i.e. we're patching an empty object).
Should we make these properties optional, given that it's a merge-patch+json request, or should we mark them as required assuming that the resource didn't exist before this request?
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.
And just to make sure that I understand correctly. We can mark properties as readonly
to indicate that it's not a user input, and it's a server generated value. This applies to generated DateTime
and maybe the modelId
(system generated).
Or asking the question in a different way. Should we use readonly
for all the responses that we return if it's not updatable? E.g. The evaluation results are responses only, should we make all its properties readonly
?
We had 2021-11-01-preview, 2022-02-01-preview and 2022-03-01-preview APIs published for the authoring. The difference between all of these API versions were made according to the feedback we get from our reviews with the API board. This final GA swagger file is highly similar to our 2022-03-01-preview APIs, except for a few changes that were also requested by the API board. |
Looking in https://github.com/Azure/azure-rest-api-specs/tree/main/specification/cognitiveservices/data-plane/Language/preview/2022-03-01-preview, for example, I don't see any authoring. I'm also a codeowner on that directory (for review purposes) and don't recall seeing any authoring APIs. Where they actually merged to main (published)? questionanswering-authoring.json was the only authoring APIs I recall viewing or could find in main. |
No, they weren't published. If you recall the previous PR that was closed, was for 2022-03-01-preview. It originally was for 2022-02-01-preview, but we moved it to 2022-03-01-preview as an evolution of the previous API, after applying the feedback we received in the PR and from the board. |
It concerns me that these were never actually published, nor have we ever generated SDKs for them and published betas. We would like to ship at least one beta of the SDKs, but any feedback we get that might affect the service may not be possible if these swaggers (and the backing service implementations) GA without previews. /cc @mayurid |
@cahann can you please chime in here? |
@heaths this has never been a requirement, we had exception for authoring SDKs. We updated the APIs in the past iterations based on the customer feedback which is the same process the question answering is following. |
@tjprescott Can you please merge this PR? |
...ification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext-authoring.json
Outdated
Show resolved
Hide resolved
@lmazuel can you merge this? It's the same issue as it has been - making the |
128a926
into
Azure:release-cognitiveservices-Language-2022-05-01-GA
* Add Language authoring 2022-05-01 APIs * Some build fixes * Add polymerphism for CLU exported project * Rename the api-version property in the import body * Retrigger CI * Update the hostTemplate and the operation Ids * Use the common error objects * Remove redundant definitions * Update the stringIndexType * Revert "Update the stringIndexType" This reverts commit 455762d. * Fix import/export object in CT * Rename actual to predicted * Add the APIs examples * Fix the examples validations * Fix prettier * Fix autorest issues * Fix nextLink examples regression * Retrigger CI * Renaming the swagger files * Apply PR feedback - part 1 * Add the documentation for the schemas * Fix spelling errors * Update the descriptions for the analyzetext-authoring * Rename project-file-version to projectFileVersion
* Cognitive Services Language GA API 2022-05-01 Swagger (#18402) * adding Swagger for GA API * remove extractive summerization changes * run .\Copy-AzSpecifications.ps1 -SourceBranch dev-cognitiveservices-Language-2022-03-01-preview * removing extractive summerization from results * removing analyze conversation APIs auto generated from March APIs * single classification with array of class as multi classification * update readme * update the read me * update read.me * code review # Conflicts: # specification/cognitiveservices/data-plane/Language/readme.md * Use azure-sdk-for-net-track2 for validation (#18756) * Add Language authoring 2022-05-01 APIs (#18694) * Add Language authoring 2022-05-01 APIs * Some build fixes * Add polymerphism for CLU exported project * Rename the api-version property in the import body * Retrigger CI * Update the hostTemplate and the operation Ids * Use the common error objects * Remove redundant definitions * Update the stringIndexType * Revert "Update the stringIndexType" This reverts commit 455762d. * Fix import/export object in CT * Rename actual to predicted * Add the APIs examples * Fix the examples validations * Fix prettier * Fix autorest issues * Fix nextLink examples regression * Retrigger CI * Renaming the swagger files * Apply PR feedback - part 1 * Add the documentation for the schemas * Fix spelling errors * Update the descriptions for the analyzetext-authoring * Rename project-file-version to projectFileVersion * Add CLU 2022-05-01 GA version (#18759) * Add CLU 2022-05-01 GA version * Remove role * Update modality to inputModality * Do not update property name to inputModality, only the enum name. * Resolve comments * Rename CustomConversation Co-authored-by: Chong Tang <[email protected]> * Update Language authoring and runtime APIs to follow the same convention (2022-05-01) (#18836) * Update authoring and runtime APIs to follow the same convention * Update the examples * Remove other references to "named" in "named entity recognition" * Remove more 'named' from the swagger * Adding the missing 'required' attribute present in preview APIs and not in the GA version (#18946) * Adding the missing 'required' attribute present in preview APIs and not in the GA version * Updates * Add api-version parameter to cancel job endpoint (#18985) * Use PascalCase for enum values (#18840) * rename LUIS to Luis * use camel case for enum values * Revert "use camel case for enum values" This reverts commit 8db93fb. Co-authored-by: Chong Tang <[email protected]> * Copy QuestionAnswering definitions to common.json and refer them in analyzeconversations.json (#19030) Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]>
* Cognitive Services Language GA API 2022-05-01 Swagger (#18402) * adding Swagger for GA API * remove extractive summerization changes * run .\Copy-AzSpecifications.ps1 -SourceBranch dev-cognitiveservices-Language-2022-03-01-preview * removing extractive summerization from results * removing analyze conversation APIs auto generated from March APIs * single classification with array of class as multi classification * update readme * update the read me * update read.me * code review * Use azure-sdk-for-net-track2 for validation (#18756) * Add Language authoring 2022-05-01 APIs (#18694) * Add Language authoring 2022-05-01 APIs * Some build fixes * Add polymerphism for CLU exported project * Rename the api-version property in the import body * Retrigger CI * Update the hostTemplate and the operation Ids * Use the common error objects * Remove redundant definitions * Update the stringIndexType * Revert "Update the stringIndexType" This reverts commit 455762d. * Fix import/export object in CT * Rename actual to predicted * Add the APIs examples * Fix the examples validations * Fix prettier * Fix autorest issues * Fix nextLink examples regression * Retrigger CI * Renaming the swagger files * Apply PR feedback - part 1 * Add the documentation for the schemas * Fix spelling errors * Update the descriptions for the analyzetext-authoring * Rename project-file-version to projectFileVersion * Add CLU 2022-05-01 GA version (#18759) * Add CLU 2022-05-01 GA version * Remove role * Update modality to inputModality * Do not update property name to inputModality, only the enum name. * Resolve comments * Rename CustomConversation Co-authored-by: Chong Tang <[email protected]> * Update Language authoring and runtime APIs to follow the same convention (2022-05-01) (#18836) * Update authoring and runtime APIs to follow the same convention * Update the examples * Remove other references to "named" in "named entity recognition" * Remove more 'named' from the swagger * Adding the missing 'required' attribute present in preview APIs and not in the GA version (#18946) * Adding the missing 'required' attribute present in preview APIs and not in the GA version * Updates * Add api-version parameter to cancel job endpoint (#18985) * Use PascalCase for enum values (#18840) * rename LUIS to Luis * use camel case for enum values * Revert "use camel case for enum values" This reverts commit 8db93fb. Co-authored-by: Chong Tang <[email protected]> * Copy QuestionAnswering definitions to common.json and refer them in analyzeconversations.json (#19030) Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]>
* Cognitive Services Language GA API 2022-05-01 Swagger (#18402) * adding Swagger for GA API * remove extractive summerization changes * run .\Copy-AzSpecifications.ps1 -SourceBranch dev-cognitiveservices-Language-2022-03-01-preview * removing extractive summerization from results * removing analyze conversation APIs auto generated from March APIs * single classification with array of class as multi classification * update readme * update the read me * update read.me * code review * Use azure-sdk-for-net-track2 for validation (#18756) * Add Language authoring 2022-05-01 APIs (#18694) * Add Language authoring 2022-05-01 APIs * Some build fixes * Add polymerphism for CLU exported project * Rename the api-version property in the import body * Retrigger CI * Update the hostTemplate and the operation Ids * Use the common error objects * Remove redundant definitions * Update the stringIndexType * Revert "Update the stringIndexType" This reverts commit 455762d. * Fix import/export object in CT * Rename actual to predicted * Add the APIs examples * Fix the examples validations * Fix prettier * Fix autorest issues * Fix nextLink examples regression * Retrigger CI * Renaming the swagger files * Apply PR feedback - part 1 * Add the documentation for the schemas * Fix spelling errors * Update the descriptions for the analyzetext-authoring * Rename project-file-version to projectFileVersion * Add CLU 2022-05-01 GA version (#18759) * Add CLU 2022-05-01 GA version * Remove role * Update modality to inputModality * Do not update property name to inputModality, only the enum name. * Resolve comments * Rename CustomConversation Co-authored-by: Chong Tang <[email protected]> * Update Language authoring and runtime APIs to follow the same convention (2022-05-01) (#18836) * Update authoring and runtime APIs to follow the same convention * Update the examples * Remove other references to "named" in "named entity recognition" * Remove more 'named' from the swagger * Adding the missing 'required' attribute present in preview APIs and not in the GA version (#18946) * Adding the missing 'required' attribute present in preview APIs and not in the GA version * Updates * Add api-version parameter to cancel job endpoint (#18985) * Use PascalCase for enum values (#18840) * rename LUIS to Luis * use camel case for enum values * Revert "use camel case for enum values" This reverts commit 8db93fb. Co-authored-by: Chong Tang <[email protected]> * Copy QuestionAnswering definitions to common.json and refer them in analyzeconversations.json (#19030) Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]> Co-authored-by: Nourhan <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]>
* Cognitive Services Language GA API 2022-05-01 Swagger (#18402) * adding Swagger for GA API * remove extractive summerization changes * run .\Copy-AzSpecifications.ps1 -SourceBranch dev-cognitiveservices-Language-2022-03-01-preview * removing extractive summerization from results * removing analyze conversation APIs auto generated from March APIs * single classification with array of class as multi classification * update readme * update the read me * update read.me * code review * Use azure-sdk-for-net-track2 for validation (#18756) * Add Language authoring 2022-05-01 APIs (#18694) * Add Language authoring 2022-05-01 APIs * Some build fixes * Add polymerphism for CLU exported project * Rename the api-version property in the import body * Retrigger CI * Update the hostTemplate and the operation Ids * Use the common error objects * Remove redundant definitions * Update the stringIndexType * Revert "Update the stringIndexType" This reverts commit 455762d. * Fix import/export object in CT * Rename actual to predicted * Add the APIs examples * Fix the examples validations * Fix prettier * Fix autorest issues * Fix nextLink examples regression * Retrigger CI * Renaming the swagger files * Apply PR feedback - part 1 * Add the documentation for the schemas * Fix spelling errors * Update the descriptions for the analyzetext-authoring * Rename project-file-version to projectFileVersion * Add CLU 2022-05-01 GA version (#18759) * Add CLU 2022-05-01 GA version * Remove role * Update modality to inputModality * Do not update property name to inputModality, only the enum name. * Resolve comments * Rename CustomConversation Co-authored-by: Chong Tang <[email protected]> * Update Language authoring and runtime APIs to follow the same convention (2022-05-01) (#18836) * Update authoring and runtime APIs to follow the same convention * Update the examples * Remove other references to "named" in "named entity recognition" * Remove more 'named' from the swagger * Adding the missing 'required' attribute present in preview APIs and not in the GA version (#18946) * Adding the missing 'required' attribute present in preview APIs and not in the GA version * Updates * Add api-version parameter to cancel job endpoint (#18985) * Use PascalCase for enum values (#18840) * rename LUIS to Luis * use camel case for enum values * Revert "use camel case for enum values" This reverts commit 8db93fb. Co-authored-by: Chong Tang <[email protected]> * Copy QuestionAnswering definitions to common.json and refer them in analyzeconversations.json (#19030) Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Heath Stewart <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]> Co-authored-by: Nourhan <[email protected]> Co-authored-by: Mohamed Abbas <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Chong Tang <[email protected]> Co-authored-by: Bidisha Chakraborty <[email protected]>
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.