From 42bf72a23303cbcadfcb595d166252207048e4a1 Mon Sep 17 00:00:00 2001 From: Chris Tufts Date: Tue, 26 Jan 2021 12:54:31 -0500 Subject: [PATCH] TA v3.1-preview.4 - Minor syntax changes to address comments on PR 12338 (#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 --- .../preview/v3.1-preview.4/TextAnalytics.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json index 1cb151752541..6d1d51acb4ca 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json @@ -443,8 +443,8 @@ }, "/entities/linking": { "post": { - "summary": "Linked entities from a well-known knowledge base", - "description": "The API returns a list of recognized entities with links to a well-known knowledge base. See the Supported languages in Text Analytics API for the list of enabled languages.", + "summary": "Linked entities from a well known knowledge base", + "description": "The API returns a list of recognized entities with links to a well known knowledge base. See the Supported languages in Text Analytics API for the list of enabled languages.", "operationId": "EntitiesLinking", "consumes": [ "application/json", @@ -470,7 +470,7 @@ ], "responses": { "200": { - "description": "A successful call results in a list of recognized entities with links to a well-known knowledge base returned for each valid document", + "description": "A successful call results in a list of recognized entities with links to a well known knowledge base returned for each valid document", "schema": { "$ref": "#/definitions/EntityLinkingResult" } @@ -694,7 +694,7 @@ "$ref": "#/definitions/KeyPhrasesTask" } }, - "EntityLinkingTasks": { + "entityLinkingTasks": { "type": "array", "items": { "$ref": "#/definitions/EntityLinkingTask" @@ -1676,7 +1676,7 @@ }, "entities": { "type": "array", - "description": "Recognized well-known entities in the document.", + "description": "Recognized well known entities in the document.", "items": { "$ref": "#/definitions/LinkedEntity" } @@ -1970,7 +1970,7 @@ "confidenceScore": { "type": "number", "format": "double", - "description": "If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." + "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." }, "text": { "type": "string", @@ -2313,7 +2313,7 @@ ], "x-ms-enum": { "name": "StringIndexTypeResponse", - "modelAsString": false, + "modelAsString": true, "values": [ { "value": "TextElements_v8", @@ -2385,7 +2385,7 @@ "enum": ["ABARoutingNumber", "ARNationalIdentityNumber", "AUBankAccountNumber", "AUDriversLicenseNumber", "AUMedicalAccountNumber", "AUPassportNumber", "AUTaxFileNumber", "AUBusinessNumber", "AUCompanyNumber", "ATIdentityCard", "ATTaxIdentificationNumber", "ATValueAddedTaxNumber", "AzureDocumentDBAuthKey", "AzureIAASDatabaseConnectionandSQLString", "AzureIoTConnectionString", "AzurePublishSettingPassword", "AzureRedisCacheString", "AzureSAS", "AzureServiceBusString", "AzureStorageAccountKey", "AzureStorageAccountGeneric", "BENationalNumber", "BENationalNumberV2", "BEValueAddedTaxNumber", "BRCPFNumber", "BRLegalEntityNumber", "BRNationalIDRG", "BGUniformCivilNumber", "CABankAccountNumber", "CADriversLicenseNumber", "CAHealthServiceNumber", "CAPassportNumber", "CAPersonalHealthIdentification", "CASocialInsuranceNumber", "CLIdentityCardNumber", "CNResidentIdentityCardNumber", "CreditCardNumber", "HRIdentityCardNumber", "HRNationalIDNumber", "HRPersonalIdentificationNumber", "HRPersonalIdentificationOIBNumberV2", "CYIdentityCard", "CYTaxIdentificationNumber", "CZPersonalIdentityNumber", "CZPersonalIdentityV2", "DKPersonalIdentificationNumber", "DKPersonalIdentificationV2", "DrugEnforcementAgencyNumber", "EEPersonalIdentificationCode", "EUDebitCardNumber", "EUDriversLicenseNumber", "EUGPSCoordinates", "EUNationalIdentificationNumber", "EUPassportNumber", "EUSocialSecurityNumber", "EUTaxIdentificationNumber", "FIEuropeanHealthNumber", "FINationalID", "FINationalIDV2", "FIPassportNumber", "FRDriversLicenseNumber", "FRHealthInsuranceNumber", "FRNationalID", "FRPassportNumber", "FRSocialSecurityNumber", "FRTaxIdentificationNumber", "FRValueAddedTaxNumber", "DEDriversLicenseNumber", "DEPassportNumber", "DEIdentityCardNumber", "DETaxIdentificationNumber", "DEValueAddedNumber", "GRNationalIDCard", "GRNationalIDV2", "GRTaxIdentificationNumber", "HKIdentityCardNumber", "HUValueAddedNumber", "HUPersonalIdentificationNumber", "HUTaxIdentificationNumber", "INPermanentAccount", "INUniqueIdentificationNumber", "IDIdentityCardNumber", "InternationlBankingAccountNumber", "IEPersonalPublicServiceNumber", "IEPersonalPublicServiceNumberV2", "ILBankAccountNumber", "ILNationalID", "ITDriversLicenseNumber", "ITFiscalCode", "ITValueAddedTaxNumber", "JPBankAccountNumber", "JPDriversLicenseNumber", "JPPassportNumber", "JPResidentRegistrationNumber", "JPSocialInsuranceNumber", "JPMyNumberCorporate", "JPMyNumberPersonal", "JPResidenceCardNumber", "LVPersonalCode", "LTPersonalCode", "LUNationalIdentificationNumberNatural", "LUNationalIdentificationNumberNonNatural", "MYIdentityCardNumber", "MAIdentityCardNumber", "MTTaxIDNumber", "NLCitizensServiceNumber", "NLCitizensServiceNumberV2", "NLTaxIdentificationNumber", "NLValueAddedTaxNumber", "NZBankAccountNumber", "NZDriversLicenseNumber", "NZInlandRevenueNumber", "NZMinistryOfHealthNumber", "NZSocialWelfareNumber", "NOIdentityNumber", "PHUnifiedMultiPurposeIDNumber", "PLIdentityCard", "PLNationalID", "PLNationalIDV2", "PLPassportNumber", "PLTaxIdentificationNumber", "PLREGONNumber", "PTCitizenCardNumber", "PTCitizenCardNumberV2", "PTTaxIdentificationNumber", "ROPersonalNumericalCode", "RUPassportNumberDomestic", "RUPassportNumberInternational", "SANationalID", "SGNationalRegistrationIdentityCardNumber", "SKPersonalNumber", "SITaxIdentificationNumber", "SIUniqueMasterCitizenNumber", "ZAIdentificationNumber", "KRResidentRegistrationNumber", "ESDNI", "ESSocialSecurityNumber", "ESTaxIdentificationNumber", "SQLServerConnectionString", "SENationalID", "SENationalIDV2", "SEPassportNumber", "SETaxIdentificationNumber", "SWIFTCode", "CHSocialSecurityNumber", "TWNationalID", "TWPassportNumber", "TWResidentCertificate", "THPopulationIdentificationCode", "TRNationalIdentificationnumber", "UKDriversLicenseNumber", "UKElectoralRollNumber", "UKNationalHealthNumber", "UKNationalInsuranceNumber", "UKUniqueTaxpayerNumber", "USUKPassportNumber", "USBankAccountNumber", "USDriversLicenseNumber", "USIndividualTaxpayerIdentification", "USSocialSecurityNumber", "UAPassportNumberDomestic", "UAPassportNumberInternational", "Organization", "Email", "URL", "Age", "PhoneNumber", "IPAddress", "Date", "Person", "Address", "All", "Default"] }, "name": "piiCategories", - "default": ["Default"], + "default": "Default", "required": false, "type": "array", "uniqueItems": true,