Skip to content
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

Dev cognitiveservices text analytics v3.1 preview.4 #12978

Merged
merged 15 commits into from
Feb 12, 2021

Conversation

anuchandy
Copy link
Member

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. 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
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh for updates in this PR

Contribution checklist:

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

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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.

ctufts and others added 15 commits January 8, 2021 15:03
* Adding changed example

* json change for om part 1

* Change API structure as well

* refine text again

* Getting back to false by default

* word chagne

* .

* final wording change

* fix for readme.md

Co-authored-by: josuh <josuh@microsoft.com>
* Made results array optional since tasks can be in a failed state with no results

* Fixing a syntax issue in the README

* Attempting to address an Autorest error in the README

* Attempting to address an Autorest error in the README

* Added some info about v3.1-preview.4 to the python readme file; attempting to correct syntax issues in readme.md

* Attempting to fix generation for the Python SDK

* Attempting to fix generation for the Python SDK

Co-authored-by: Abigail Hartman <Abigail.Hartman@microsoft.com>
#12340)

* updated examples and health definitions for new preview version

* fixed linting issue in readme

* removed old properties in ta.json

* undo changes to sentiment portion of response, update health response

* fixed spelling issues

* fixed more typose

* remove linting issue in readme

* added enums to assertions

* add in ms-enum extension

* ran prettier json linter over files

* made assertion field singular
* based off of correct branch now

* change the request from enum to a generic list of strings

* cleanup some other comments

* add enum type

* change type --> category

* add categories to the swagger

* update the types to make them read better

* add in the NER types

* add in address type as well

* fix some typos

* one last typo
* updated examples and health definitions for new preview version

* fixed linting issue in readme

* removed old properties in ta.json

* undo changes to sentiment portion of response, update health response

* fixed spelling issues

* fixed more typose

* remove linting issue in readme

* added enums to assertions

* add in ms-enum extension

* ran prettier json linter over files

* made assertion field singular

* addressed comments and updated description
…338 (#12650)

* updated examples and health definitions for new preview version

* fixed linting issue in readme

* removed old properties in ta.json

* undo changes to sentiment portion of response, update health response

* fixed spelling issues

* fixed more typose

* remove linting issue in readme

* added enums to assertions

* add in ms-enum extension

* ran prettier json linter over files

* made assertion field singular

* addressed comments and updated description

* addressed comments for minor syntax changes

* replaced all instances of well-known

* fixed linting issue - pii category was set to list instead of string
…12660)

* Trying to solve swagger validation issues

* Removed x-ms-enum property from PiiCategories

* Created a definition for PiiCategories in addition to a parameter in order to support passing the same thing in the body of a Task object

* Ran 'prettier' to, uh... make it prettier.

* Updated custom-words.txt

* Corrected typos in Swagger and removed unneeded entries in custom-words.txt

* Changed 'default' to 'x-ms-client-default' in order to pass both model validation and linting

* Fixed a misspelled PII category

* Reran prettier check

* Removed an experimental line in the Swagger

* Adding collectionFormat to fix an autorest error

* Removing x-ms-client-default

Co-authored-by: Abigail Hartman <Abigail.Hartman@microsoft.com>
…es text analytics v3.1 preview.4 (#12737)

* updated examples and health definitions for new preview version

* fixed linting issue in readme

* removed old properties in ta.json

* undo changes to sentiment portion of response, update health response

* fixed spelling issues

* fixed more typose

* remove linting issue in readme

* added enums to assertions

* add in ms-enum extension

* ran prettier json linter over files

* made assertion field singular

* addressed comments and updated description

* addressed comments for minor syntax changes

* replaced all instances of well-known

* fixed linting issue - pii category was set to list instead of string

* revert change to pii default

* remove default value as this is an optional parameter

* added extensible list to relation types for healthcare

* revert change to pii default

* changed enum type and made extensible via the modelAsString param
@openapi-workflow-bot
Copy link

Hi, @anuchandy Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 12, 2021

    Swagger Validation Report

    ️⌛BreakingChange pending [Detail]
    ️⚠️LintDiff: 1 Warnings warning [Detail]

    Rule Message
    ⚠️ R3017 - GuidUsage Guid used in model definition 'JobMetadata' for property 'jobId'. 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: TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json#L2037
    ️⌛Avocado pending [Detail]
    ️⌛ModelValidation pending [Detail]
    ️⌛SemanticValidation pending [Detail]
    ️⌛[Staging] Cross Version BreakingChange (Base on preview version) pending [Detail]
    ️⌛[Staging] Cross Version BreakingChange (Base on stable version) pending [Detail]
    ️⌛CredScan pending [Detail]
    ️⌛[Staging] SDK Track2 Validation pending [Detail]
    ️⌛[Staging] PrettierCheck pending [Detail]
    ️⌛[Staging] SpellCheck pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 12, 2021

    Swagger Generation Artifacts

    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 677dd68f0ccd7477f74284a86f2f1514383a1c5a. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-02-12 21:48:11 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs] Generate from 677dd68f0ccd7477f74284a86f2f1514383a1c5a. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmdout	[automation_generate.sh] [Autorest]
      cmdout	[automation_generate.sh] [Autorest] (node:3425) ExperimentalWarning: The fs.promises API is experimental
      cmdout	[automation_generate.sh] [Autorest]    Loading AutoRest core      '/home/vsts/.autorest/@autorest_core@3.0.6373/node_modules/@autorest/core/dist' (3.0.6373)
      cmdout	[automation_generate.sh] [Autorest] (node:3473) ExperimentalWarning: The fs.promises API is experimental
      cmdout	[automation_generate.sh] [Autorest]   TypeError: Cannot read property 'pass-thru' of undefined
      cmdout	[automation_generate.sh] [Autorest]../azure-sdk-for-python_tmp/generateOutput.json does not exist!!!
      warn	File azure-sdk-for-python_tmp/generateOutput.json not found to read
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 677dd68f0ccd7477f74284a86f2f1514383a1c5a. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/cognitiveservices/data-plane/TextAnalytics/readme.md
    • ️✔️@azure/cognitiveservices-textanalytics [View full logs]  [Preview SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/textAnalyticsClient.js → ./dist/cognitiveservices-textanalytics.js...
      cmderr	[npmPack] created ./dist/cognitiveservices-textanalytics.js in 166ms
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 677dd68f0ccd7477f74284a86f2f1514383a1c5a. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️cognitiveservices/v2.1/textanalytics [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️cognitiveservices/v2.0/textanalytics [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    Posted by Swagger Pipeline | How to fix these errors?

    @anuchandy
    Copy link
    Member Author

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @anuchandy anuchandy merged commit 91a067a into master Feb 12, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * Adds base for updating TextAnalytics from version preview/v3.1-preview.3 to version v3.1-preview.4
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * add entity linking task (Azure#12366)
    
    * Opinion Mining API changes for Preview.4 (Azure#12344)
    
    * Adding changed example
    
    * json change for om part 1
    
    * Change API structure as well
    
    * refine text again
    
    * Getting back to false by default
    
    * word chagne
    
    * .
    
    * final wording change
    
    * fix for readme.md
    
    Co-authored-by: josuh <josuh@microsoft.com>
    
    * Analyze: made task results optional (Azure#12373)
    
    * Made results array optional since tasks can be in a failed state with no results
    
    * Fixing a syntax issue in the README
    
    * Attempting to address an Autorest error in the README
    
    * Attempting to address an Autorest error in the README
    
    * Added some info about v3.1-preview.4 to the python readme file; attempting to correct syntax issues in readme.md
    
    * Attempting to fix generation for the Python SDK
    
    * Attempting to fix generation for the Python SDK
    
    Co-authored-by: Abigail Hartman <Abigail.Hartman@microsoft.com>
    
    * add stringtype parameter to entitylinking task (Azure#12467)
    
    * TA v3.1-preview.4 - updated examples and definitions for TA for Health (Azure#12340)
    
    * updated examples and health definitions for new preview version
    
    * fixed linting issue in readme
    
    * removed old properties in ta.json
    
    * undo changes to sentiment portion of response, update health response
    
    * fixed spelling issues
    
    * fixed more typose
    
    * remove linting issue in readme
    
    * added enums to assertions
    
    * add in ms-enum extension
    
    * ran prettier json linter over files
    
    * made assertion field singular
    
    * PII Types for 3.1-Preview.4 (Azure#12392)
    
    * based off of correct branch now
    
    * change the request from enum to a generic list of strings
    
    * cleanup some other comments
    
    * add enum type
    
    * change type --> category
    
    * add categories to the swagger
    
    * update the types to make them read better
    
    * add in the NER types
    
    * add in address type as well
    
    * fix some typos
    
    * one last typo
    
    * Health descritpion and naming updates (Azure#12616)
    
    * updated examples and health definitions for new preview version
    
    * fixed linting issue in readme
    
    * removed old properties in ta.json
    
    * undo changes to sentiment portion of response, update health response
    
    * fixed spelling issues
    
    * fixed more typose
    
    * remove linting issue in readme
    
    * added enums to assertions
    
    * add in ms-enum extension
    
    * ran prettier json linter over files
    
    * made assertion field singular
    
    * addressed comments and updated description
    
    * TA v3.1-preview.4 - Minor syntax changes to address comments on PR 12338  (Azure#12650)
    
    * updated examples and health definitions for new preview version
    
    * fixed linting issue in readme
    
    * removed old properties in ta.json
    
    * undo changes to sentiment portion of response, update health response
    
    * fixed spelling issues
    
    * fixed more typose
    
    * remove linting issue in readme
    
    * added enums to assertions
    
    * add in ms-enum extension
    
    * ran prettier json linter over files
    
    * made assertion field singular
    
    * addressed comments and updated description
    
    * addressed comments for minor syntax changes
    
    * replaced all instances of well-known
    
    * fixed linting issue - pii category was set to list instead of string
    
    * [text analytics] Fixed Swagger validation issues for v3.1-preview.4 (Azure#12660)
    
    * Trying to solve swagger validation issues
    
    * Removed x-ms-enum property from PiiCategories
    
    * Created a definition for PiiCategories in addition to a parameter in order to support passing the same thing in the body of a Task object
    
    * Ran 'prettier' to, uh... make it prettier.
    
    * Updated custom-words.txt
    
    * Corrected typos in Swagger and removed unneeded entries in custom-words.txt
    
    * Changed 'default' to 'x-ms-client-default' in order to pass both model validation and linting
    
    * Fixed a misspelled PII category
    
    * Reran prettier check
    
    * Removed an experimental line in the Swagger
    
    * Adding collectionFormat to fix an autorest error
    
    * Removing x-ms-client-default
    
    Co-authored-by: Abigail Hartman <Abigail.Hartman@microsoft.com>
    
    * Added Extensible Enum for Health Relation Types - Dev cognitiveservices text analytics v3.1 preview.4 (Azure#12737)
    
    * updated examples and health definitions for new preview version
    
    * fixed linting issue in readme
    
    * removed old properties in ta.json
    
    * undo changes to sentiment portion of response, update health response
    
    * fixed spelling issues
    
    * fixed more typose
    
    * remove linting issue in readme
    
    * added enums to assertions
    
    * add in ms-enum extension
    
    * ran prettier json linter over files
    
    * made assertion field singular
    
    * addressed comments and updated description
    
    * addressed comments for minor syntax changes
    
    * replaced all instances of well-known
    
    * fixed linting issue - pii category was set to list instead of string
    
    * revert change to pii default
    
    * remove default value as this is an optional parameter
    
    * added extensible list to relation types for healthcare
    
    * revert change to pii default
    
    * changed enum type and made extensible via the modelAsString param
    
    * ran npm prettier check and fixed spelling error (Azure#12947)
    
    Co-authored-by: Chris Tufts <christopher.tufts25@gmail.com>
    Co-authored-by: Mikael <mikael.sitruk@outlook.com>
    Co-authored-by: Joohee Suh <58048046+josuhazure@users.noreply.github.com>
    Co-authored-by: josuh <josuh@microsoft.com>
    Co-authored-by: Abigail Hartman <Abigail.Hahn@microsoft.com>
    Co-authored-by: Abigail Hartman <Abigail.Hartman@microsoft.com>
    Co-authored-by: Thaminda Edirisooriya <61993993+thediris@users.noreply.github.com>
    @JackTn JackTn deleted the dev-cognitiveservices-TextAnalytics-v3.1-preview.4 branch August 17, 2021 06:06
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants