Language API for TA (2022-03-01-preview) #17281

abhahn · 2022-01-07T19:23:04Z

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:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

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.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

…into abhahn/language-ta

…hn/azure-rest-api-specs into abhahn/language-ta-20211101

…tructure

…other preview)

…into abhahn/language-ta-20211101

…02-01

ghost · 2022-02-20T16:02:21Z

Hi, @abhahn. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

ghost · 2022-03-07T05:02:08Z

Hi, @abhahn. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

deyaaeldeen

Looks good!

johanste · 2022-03-14T22:16:57Z

...fication/cognitiveservices/data-plane/Language/preview/2022-03-01-preview/textanalytics.json

@@ -645,7 +682,7 @@
    "SingleClassificationDocumentResult": {
      "type": "object",
      "properties": {
-        "classification": {
+        "class": {


My only concern is what various clients will call this (since class is often a reserved/keyword). I don't think I thought about this in the REST API discussion. But we should be able to specify x-ms-client-name to rename/quantify the name in client libraries.

mikekistler

Looks good! 👍

kristapratico

confirming that generation looks good 👍

…ttps://github.com/Azure/azure-rest-api-specs into abhahn/language-ta-20220301

* Add blockchain to latest profile * Add additional types * WIP for language api spec for TA * Updated preview version number; finished up async definitions * Finished first draft of full spec * Finished first draft of full spec, minus FHIR structuring in HC output * Removed features not included in 2021-11-01 preview * Update custom text tasks TODOs * Moved common definitions to TA-specific definitions * Added custom text tasks to JobManifest * Addressing feedback from PR comments and internal review * Addressed some PR comments * Updated some remaining references to documents * PR comments * Updated a previous change * Reverted references to 'records' back to 'documents' * A few small updates to examples; removed base Task type to simplify structure * PR comments * Addressed TODO items; removed LD-related objects (will be added in another preview) * Fixed anonymous types * Removed required field for body in POST request * Fix prettier check * Added a few more details; experimental change for documents property * Ran prettier * Correction to AnalysisInput object * Merged changes from 2021-11-01-preview and moved new changes to 2022-02-01 * PR comments * Updates to the design for tasks * Added custom entities task to examples * Updates * Finished implementation of discriminator pattern and added some exmaples * Updates * Prettier * Fixed semantic validation errors * Fixed model validation * Another model validation fix * Debugging model validation errors * Using a different discriminator enum for output schemas * Fixed some missing discriminator updates * More semantic validation fixes * Fixed model validation errors; updated sample names * Fixed linting errors and addressed some warnings in the linter output * Ran prettier on examples * PR comments and some minor restructuring * Ran prettier * Removed a duplicate schema from CustomEntitiesTaskParameters * PR comments * PR comments * PR comments * Added missing job task status 'partiallySucceeded' * Added preview folder for 2022-03-01-preview * Added delete and cancel operations for jobs * Added some examples for delete and cancel; updated samples for new preview * Incorporating feedback from the API review * fix naming consistency (#1) * naming updates * fix typo * Fixed one last merge conflict * naming fix (#2) * Fixed a ref * Ran prettier on all files Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Abigail Hartman <Abigail.Hartman@microsoft.com> Co-authored-by: Kareem Yousef <kayousef@microsoft.com> Co-authored-by: Abby Hartman <abhahn@microsoft.com> Co-authored-by: Mohamed Shaban <official.mohamedshaban@gmail.com>

* Add blockchain to latest profile * Add additional types * WIP for language api spec for TA * Updated preview version number; finished up async definitions * Finished first draft of full spec * Finished first draft of full spec, minus FHIR structuring in HC output * Removed features not included in 2021-11-01 preview * Update custom text tasks TODOs * Moved common definitions to TA-specific definitions * Added custom text tasks to JobManifest * Addressing feedback from PR comments and internal review * Addressed some PR comments * Updated some remaining references to documents * PR comments * Updated a previous change * Reverted references to 'records' back to 'documents' * A few small updates to examples; removed base Task type to simplify structure * PR comments * Addressed TODO items; removed LD-related objects (will be added in another preview) * Fixed anonymous types * Removed required field for body in POST request * Fix prettier check * Added a few more details; experimental change for documents property * Ran prettier * Correction to AnalysisInput object * Merged changes from 2021-11-01-preview and moved new changes to 2022-02-01 * PR comments * Updates to the design for tasks * Added custom entities task to examples * Updates * Finished implementation of discriminator pattern and added some exmaples * Updates * Prettier * Fixed semantic validation errors * Fixed model validation * Another model validation fix * Debugging model validation errors * Using a different discriminator enum for output schemas * Fixed some missing discriminator updates * More semantic validation fixes * Fixed model validation errors; updated sample names * Fixed linting errors and addressed some warnings in the linter output * Ran prettier on examples * PR comments and some minor restructuring * Ran prettier * Removed a duplicate schema from CustomEntitiesTaskParameters * PR comments * PR comments * PR comments * Added missing job task status 'partiallySucceeded' * Added preview folder for 2022-03-01-preview * Added delete and cancel operations for jobs * Added some examples for delete and cancel; updated samples for new preview * Incorporating feedback from the API review * fix naming consistency (Azure#1) * naming updates * fix typo * Fixed one last merge conflict * naming fix (Azure#2) * Fixed a ref * Ran prettier on all files Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com> Co-authored-by: Abigail Hartman <Abigail.Hartman@microsoft.com> Co-authored-by: Kareem Yousef <kayousef@microsoft.com> Co-authored-by: Abby Hartman <abhahn@microsoft.com> Co-authored-by: Mohamed Shaban <official.mohamedshaban@gmail.com>

markcowl and others added 30 commits August 21, 2019 19:39

Add blockchain to latest profile

1bcc20d

Add additional types

7b46097

WIP for language api spec for TA

d141546

Merge branch 'main' of https://github.com/Azure/azure-rest-api-specs …

45fff3b

…into abhahn/language-ta

Updated preview version number; finished up async definitions

382b4ab

Finished first draft of full spec

478b59b

Finished first draft of full spec, minus FHIR structuring in HC output

b9c5551

Removed features not included in 2021-11-01 preview

5541ae2

Update custom text tasks TODOs

054c150

Moved common definitions to TA-specific definitions

61e358d

Added custom text tasks to JobManifest

31e30a8

Merge branch 'abhahn/language-ta-20211101' of https://github.com/abha…

113da22

…hn/azure-rest-api-specs into abhahn/language-ta-20211101

Addressing feedback from PR comments and internal review

c2b44e5

Addressed some PR comments

971c0c9

Updated some remaining references to documents

6603e9f

PR comments

9603885

Updated a previous change

00611d6

Reverted references to 'records' back to 'documents'

dae7e0c

Fixed merge conflict

3dec90a

A few small updates to examples; removed base Task type to simplify s…

ef4ca82

…tructure

PR comments

9de0612

Addressed TODO items; removed LD-related objects (will be added in an…

37afdf2

…other preview)

Fixed anonymous types

b129a0c

Removed required field for body in POST request

6589b0e

Fix prettier check

61c4920

Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs …

341d6c2

…into abhahn/language-ta-20211101

Added a few more details; experimental change for documents property

b2c0887

Ran prettier

b6d9fb1

Correction to AnalysisInput object

b0fbc2e

Merged changes from 2021-11-01-preview and moved new changes to 2022-…

191433c

…02-01

czubair removed a link to an issue Feb 10, 2022

[Language Service - Authoring, Custom Text, CLU] REST API Review of Concept Naming in Language Service #17249

Closed

ghost added the no-recent-activity label Feb 20, 2022

ghost closed this Mar 7, 2022

abhahn reopened this Mar 8, 2022

ghost removed the no-recent-activity label Mar 8, 2022

abhahn requested review from mikekistler, johanste, kristapratico, deyaaeldeen, mssfang, jsquire and kayousef-zz March 14, 2022 18:44

deyaaeldeen approved these changes Mar 14, 2022

View reviewed changes

mssfang approved these changes Mar 14, 2022

View reviewed changes

johanste reviewed Mar 14, 2022

View reviewed changes

johanste approved these changes Mar 14, 2022

View reviewed changes

mikekistler approved these changes Mar 14, 2022

View reviewed changes

kristapratico approved these changes Mar 15, 2022

View reviewed changes

kristapratico mentioned this pull request Mar 15, 2022

[textanalytics] support for cancellation of an analyze job Azure/azure-sdk-for-python#23530

Closed

2 tasks

Merge branch 'dev-cognitiveservices-Language-2022-03-01-preview' of h…

0643faa

…ttps://github.com/Azure/azure-rest-api-specs into abhahn/language-ta-20220301

lmazuel merged commit 472892b into Azure:dev-cognitiveservices-Language-2022-03-01-preview Mar 17, 2022

heaths mentioned this pull request Apr 7, 2022

Set codeowners for Cognitive Lanugage swaggers #18602

Merged

jsquire mentioned this pull request Apr 8, 2022

[Text Analytics] Support Cancellation of an Analyze Job Azure/azure-sdk-for-net#28116

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Language API for TA (2022-03-01-preview) #17281

Language API for TA (2022-03-01-preview) #17281

abhahn commented Jan 7, 2022

ghost commented Feb 20, 2022

ghost commented Mar 7, 2022

deyaaeldeen left a comment

johanste Mar 14, 2022

mikekistler left a comment

kristapratico left a comment

Language API for TA (2022-03-01-preview) #17281

Language API for TA (2022-03-01-preview) #17281

Conversation

abhahn commented Jan 7, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

ghost commented Feb 20, 2022

ghost commented Mar 7, 2022

deyaaeldeen left a comment

Choose a reason for hiding this comment

johanste Mar 14, 2022

Choose a reason for hiding this comment

mikekistler left a comment

Choose a reason for hiding this comment

kristapratico left a comment

Choose a reason for hiding this comment