Add May Preview And May GA changes for Analyze ConversationsAurghob/convmaypreview ga #28841
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aurghob
requested review from
annatisch,
heaths,
deyaaeldeen,
kristapratico,
mssfang,
joseharriaga,
minhanh-phan,
a team and
yangyuan
as code owners
aurghob
requested review from
MushMal and
marclerwick
and removed request for
a team
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| analyzeconversations.json | 2024-05-15-preview(0eb0bfe) | 2023-04-01(main) |
| analyzeconversations.json | 2024-05-15-preview(0eb0bfe) | 2023-11-15-preview(main) |
| analyzeconversations.json | 2024-05-01(0eb0bfe) | 2023-04-01(main) |
| analyzeconversations.json | 2024-05-01(0eb0bfe) | 2023-11-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 26 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| release_2024-05-15-preview | release_2024-05-15-preview(0eb0bfe) | default(main) |
| release_2024-05-01 | release_2024-05-01(0eb0bfe) | default(main) |
| release_2024-05-15-preview | release_2024-05-15-preview(0eb0bfe) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Security definition should have a description. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L41 |
||
| OperationId should be of the form 'Noun_Verb' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L51 |
||
| OperationId should be of the form 'Noun_Verb' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L101 |
||
| 'GET' operation 'AnalyzeConversationsJobStatus' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L165 |
||
| OperationId should be of the form 'Noun_Verb' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L165 |
||
| OperationId for get method should contain 'Get' or 'list' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L165 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L172 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L180 |
||
| OperationId should be of the form 'Noun_Verb' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L232 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L239 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L832 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1037 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1101 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1105 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1436 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1453 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1688 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1778 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1782 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1980 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L2842 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3037 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3041 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3045 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3054 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3731 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| Security definition should have a description. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L41 |
|
| OperationId should be of the form 'Noun_Verb' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L51 |
|
| OperationId should be of the form 'Noun_Verb' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L101 |
|
| 'GET' operation 'AnalyzeConversationsJobStatus' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L165 |
|
| OperationId should be of the form 'Noun_Verb' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L165 |
|
| OperationId for get method should contain 'Get' or 'list' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L165 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L172 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L180 |
|
| OperationId should be of the form 'Noun_Verb' Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L232 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L239 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L832 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1037 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1101 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1105 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1436 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1453 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1688 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1778 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1782 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L1980 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L2842 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3037 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3041 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3045 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3054 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Language/preview/2024-05-15-preview/analyzeconversations.json#L3731 |
|
| Security definition should have a description. Location: Language/stable/2024-05-01/analyzeconversations.json#L41 |
|
| OperationId should be of the form 'Noun_Verb' Location: Language/stable/2024-05-01/analyzeconversations.json#L51 |
|
| OperationId should be of the form 'Noun_Verb' Location: Language/stable/2024-05-01/analyzeconversations.json#L101 |
|
| 'GET' operation 'AnalyzeConversationsJobStatus' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Language/stable/2024-05-01/analyzeconversations.json#L162 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
bidisha-c
approved these changes
Apr 25, 2024
heaths
approved these changes
May 6, 2024
specification/cognitiveservices/Language.Conversations/main.tsp
Outdated
Show resolved
Hide resolved
mikekistler
approved these changes
May 8, 2024
mikekistler
added
the
APIStewardshipBoard-SignedOff
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
|
There are no new suppressions in this PR. I'll open a tracking issue for this, but it should not block the PR. |
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
…onvmaypreview ga (Azure#28841) * Add examples and api version for May GA and Preview * Add Aspect related tsp changes * Some API version corrections * Remove Custom Conv Summarization examples from May GA examples * minor api adjustments for other custom conv summarization attributes * Add an example and specifications for entity tags (#1) * compile fixes * Add examples * Examples changes * Changes to remove older preview API version in Analyze conversations * Fix compile error and add compiled swagger json * Fix some avocado and prettier check issues * Fix some more lintdiff and avocado errors * Correct Readme * Fix typespec validation * Address minor documenatation comment --------- Co-authored-by: Aurgho Bhattacharjee <aurghob@microsoft.com> Co-authored-by: nithya4 <13850604+nithya4@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
Adding May Preview and May GA API for Analyze Conversations API for Cognitive Services Language.
This change is based off an API review done on 4/9 : #28093 and takes changes from quentinRobinson#1 and https://github.com/aurghob/azure-rest-api-specs/pull/1.
Brief overview of changes:
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 ApiViewcomment 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
Checks stuck in `queued` state?
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.