@azure/ai-text-analytics 6.0.0-alpha.20220607.1 → 6.0.0-alpha.20220617.2

package/dist-esm/src/generated/models/index.js

@@ -8,85 +8,145 @@
 /** Known values of {@link AnalyzeTextTaskKind} that the service accepts. */
 export var KnownAnalyzeTextTaskKind;
 (function (KnownAnalyzeTextTaskKind) {
+    /** SentimentAnalysis */
     KnownAnalyzeTextTaskKind["SentimentAnalysis"] = "SentimentAnalysis";
+    /** EntityRecognition */
     KnownAnalyzeTextTaskKind["EntityRecognition"] = "EntityRecognition";
+    /** PiiEntityRecognition */
     KnownAnalyzeTextTaskKind["PiiEntityRecognition"] = "PiiEntityRecognition";
+    /** KeyPhraseExtraction */
     KnownAnalyzeTextTaskKind["KeyPhraseExtraction"] = "KeyPhraseExtraction";
+    /** LanguageDetection */
     KnownAnalyzeTextTaskKind["LanguageDetection"] = "LanguageDetection";
+    /** EntityLinking */
     KnownAnalyzeTextTaskKind["EntityLinking"] = "EntityLinking";
 })(KnownAnalyzeTextTaskKind || (KnownAnalyzeTextTaskKind = {}));
 /** Known values of {@link AnalyzeTextTaskResultsKind} that the service accepts. */
 export var KnownAnalyzeTextTaskResultsKind;
 (function (KnownAnalyzeTextTaskResultsKind) {
+    /** SentimentAnalysisResults */
     KnownAnalyzeTextTaskResultsKind["SentimentAnalysisResults"] = "SentimentAnalysisResults";
+    /** EntityRecognitionResults */
     KnownAnalyzeTextTaskResultsKind["EntityRecognitionResults"] = "EntityRecognitionResults";
+    /** PiiEntityRecognitionResults */
     KnownAnalyzeTextTaskResultsKind["PiiEntityRecognitionResults"] = "PiiEntityRecognitionResults";
+    /** KeyPhraseExtractionResults */
     KnownAnalyzeTextTaskResultsKind["KeyPhraseExtractionResults"] = "KeyPhraseExtractionResults";
+    /** LanguageDetectionResults */
     KnownAnalyzeTextTaskResultsKind["LanguageDetectionResults"] = "LanguageDetectionResults";
+    /** EntityLinkingResults */
     KnownAnalyzeTextTaskResultsKind["EntityLinkingResults"] = "EntityLinkingResults";
 })(KnownAnalyzeTextTaskResultsKind || (KnownAnalyzeTextTaskResultsKind = {}));
 /** Known values of {@link ErrorCode} that the service accepts. */
 export var KnownErrorCode;
 (function (KnownErrorCode) {
+    /** InvalidRequest */
     KnownErrorCode["InvalidRequest"] = "InvalidRequest";
+    /** InvalidArgument */
     KnownErrorCode["InvalidArgument"] = "InvalidArgument";
+    /** Unauthorized */
     KnownErrorCode["Unauthorized"] = "Unauthorized";
+    /** Forbidden */
     KnownErrorCode["Forbidden"] = "Forbidden";
+    /** NotFound */
     KnownErrorCode["NotFound"] = "NotFound";
+    /** ProjectNotFound */
     KnownErrorCode["ProjectNotFound"] = "ProjectNotFound";
+    /** OperationNotFound */
     KnownErrorCode["OperationNotFound"] = "OperationNotFound";
+    /** AzureCognitiveSearchNotFound */
     KnownErrorCode["AzureCognitiveSearchNotFound"] = "AzureCognitiveSearchNotFound";
+    /** AzureCognitiveSearchIndexNotFound */
     KnownErrorCode["AzureCognitiveSearchIndexNotFound"] = "AzureCognitiveSearchIndexNotFound";
+    /** TooManyRequests */
     KnownErrorCode["TooManyRequests"] = "TooManyRequests";
+    /** AzureCognitiveSearchThrottling */
     KnownErrorCode["AzureCognitiveSearchThrottling"] = "AzureCognitiveSearchThrottling";
+    /** AzureCognitiveSearchIndexLimitReached */
     KnownErrorCode["AzureCognitiveSearchIndexLimitReached"] = "AzureCognitiveSearchIndexLimitReached";
+    /** InternalServerError */
     KnownErrorCode["InternalServerError"] = "InternalServerError";
+    /** ServiceUnavailable */
     KnownErrorCode["ServiceUnavailable"] = "ServiceUnavailable";
 })(KnownErrorCode || (KnownErrorCode = {}));
 /** Known values of {@link InnerErrorCode} that the service accepts. */
 export var KnownInnerErrorCode;
 (function (KnownInnerErrorCode) {
+    /** InvalidRequest */
     KnownInnerErrorCode["InvalidRequest"] = "InvalidRequest";
+    /** InvalidParameterValue */
     KnownInnerErrorCode["InvalidParameterValue"] = "InvalidParameterValue";
+    /** KnowledgeBaseNotFound */
     KnownInnerErrorCode["KnowledgeBaseNotFound"] = "KnowledgeBaseNotFound";
+    /** AzureCognitiveSearchNotFound */
     KnownInnerErrorCode["AzureCognitiveSearchNotFound"] = "AzureCognitiveSearchNotFound";
+    /** AzureCognitiveSearchThrottling */
     KnownInnerErrorCode["AzureCognitiveSearchThrottling"] = "AzureCognitiveSearchThrottling";
+    /** ExtractionFailure */
     KnownInnerErrorCode["ExtractionFailure"] = "ExtractionFailure";
+    /** InvalidRequestBodyFormat */
     KnownInnerErrorCode["InvalidRequestBodyFormat"] = "InvalidRequestBodyFormat";
+    /** EmptyRequest */
     KnownInnerErrorCode["EmptyRequest"] = "EmptyRequest";
+    /** MissingInputDocuments */
     KnownInnerErrorCode["MissingInputDocuments"] = "MissingInputDocuments";
+    /** InvalidDocument */
     KnownInnerErrorCode["InvalidDocument"] = "InvalidDocument";
+    /** ModelVersionIncorrect */
     KnownInnerErrorCode["ModelVersionIncorrect"] = "ModelVersionIncorrect";
+    /** InvalidDocumentBatch */
     KnownInnerErrorCode["InvalidDocumentBatch"] = "InvalidDocumentBatch";
+    /** UnsupportedLanguageCode */
     KnownInnerErrorCode["UnsupportedLanguageCode"] = "UnsupportedLanguageCode";
+    /** InvalidCountryHint */
     KnownInnerErrorCode["InvalidCountryHint"] = "InvalidCountryHint";
 })(KnownInnerErrorCode || (KnownInnerErrorCode = {}));
 /** Known values of {@link AnalyzeTextLROTaskKind} that the service accepts. */
 export var KnownAnalyzeTextLROTaskKind;
 (function (KnownAnalyzeTextLROTaskKind) {
+    /** SentimentAnalysis */
     KnownAnalyzeTextLROTaskKind["SentimentAnalysis"] = "SentimentAnalysis";
+    /** EntityRecognition */
     KnownAnalyzeTextLROTaskKind["EntityRecognition"] = "EntityRecognition";
+    /** PiiEntityRecognition */
     KnownAnalyzeTextLROTaskKind["PiiEntityRecognition"] = "PiiEntityRecognition";
+    /** KeyPhraseExtraction */
     KnownAnalyzeTextLROTaskKind["KeyPhraseExtraction"] = "KeyPhraseExtraction";
+    /** EntityLinking */
     KnownAnalyzeTextLROTaskKind["EntityLinking"] = "EntityLinking";
+    /** Healthcare */
     KnownAnalyzeTextLROTaskKind["Healthcare"] = "Healthcare";
+    /** ExtractiveSummarization */
     KnownAnalyzeTextLROTaskKind["ExtractiveSummarization"] = "ExtractiveSummarization";
+    /** CustomEntityRecognition */
     KnownAnalyzeTextLROTaskKind["CustomEntityRecognition"] = "CustomEntityRecognition";
+    /** CustomSingleLabelClassification */
     KnownAnalyzeTextLROTaskKind["CustomSingleLabelClassification"] = "CustomSingleLabelClassification";
+    /** CustomMultiLabelClassification */
     KnownAnalyzeTextLROTaskKind["CustomMultiLabelClassification"] = "CustomMultiLabelClassification";
 })(KnownAnalyzeTextLROTaskKind || (KnownAnalyzeTextLROTaskKind = {}));
 /** Known values of {@link AnalyzeTextLROResultsKind} that the service accepts. */
 export var KnownAnalyzeTextLROResultsKind;
 (function (KnownAnalyzeTextLROResultsKind) {
+    /** SentimentAnalysisLROResults */
     KnownAnalyzeTextLROResultsKind["SentimentAnalysisLROResults"] = "SentimentAnalysisLROResults";
+    /** EntityRecognitionLROResults */
     KnownAnalyzeTextLROResultsKind["EntityRecognitionLROResults"] = "EntityRecognitionLROResults";
+    /** PiiEntityRecognitionLROResults */
     KnownAnalyzeTextLROResultsKind["PiiEntityRecognitionLROResults"] = "PiiEntityRecognitionLROResults";
+    /** KeyPhraseExtractionLROResults */
     KnownAnalyzeTextLROResultsKind["KeyPhraseExtractionLROResults"] = "KeyPhraseExtractionLROResults";
+    /** EntityLinkingLROResults */
     KnownAnalyzeTextLROResultsKind["EntityLinkingLROResults"] = "EntityLinkingLROResults";
+    /** HealthcareLROResults */
     KnownAnalyzeTextLROResultsKind["HealthcareLROResults"] = "HealthcareLROResults";
+    /** ExtractiveSummarizationLROResults */
     KnownAnalyzeTextLROResultsKind["ExtractiveSummarizationLROResults"] = "ExtractiveSummarizationLROResults";
+    /** CustomEntityRecognitionLROResults */
     KnownAnalyzeTextLROResultsKind["CustomEntityRecognitionLROResults"] = "CustomEntityRecognitionLROResults";
+    /** CustomSingleLabelClassificationLROResults */
     KnownAnalyzeTextLROResultsKind["CustomSingleLabelClassificationLROResults"] = "CustomSingleLabelClassificationLROResults";
+    /** CustomMultiLabelClassificationLROResults */
     KnownAnalyzeTextLROResultsKind["CustomMultiLabelClassificationLROResults"] = "CustomMultiLabelClassificationLROResults";
 })(KnownAnalyzeTextLROResultsKind || (KnownAnalyzeTextLROResultsKind = {}));
 /** Known values of {@link StringIndexType} that the service accepts. */
@@ -110,244 +170,467 @@ export var KnownPiiEntityDomain;
 /** Known values of {@link PiiEntityCategory} that the service accepts. */
 export var KnownPiiEntityCategory;
 (function (KnownPiiEntityCategory) {
+    /** ABARoutingNumber */
     KnownPiiEntityCategory["ABARoutingNumber"] = "ABARoutingNumber";
+    /** ARNationalIdentityNumber */
     KnownPiiEntityCategory["ARNationalIdentityNumber"] = "ARNationalIdentityNumber";
+    /** AUBankAccountNumber */
     KnownPiiEntityCategory["AUBankAccountNumber"] = "AUBankAccountNumber";
+    /** AUDriversLicenseNumber */
     KnownPiiEntityCategory["AUDriversLicenseNumber"] = "AUDriversLicenseNumber";
+    /** AUMedicalAccountNumber */
     KnownPiiEntityCategory["AUMedicalAccountNumber"] = "AUMedicalAccountNumber";
+    /** AUPassportNumber */
     KnownPiiEntityCategory["AUPassportNumber"] = "AUPassportNumber";
+    /** AUTaxFileNumber */
     KnownPiiEntityCategory["AUTaxFileNumber"] = "AUTaxFileNumber";
+    /** AUBusinessNumber */
     KnownPiiEntityCategory["AUBusinessNumber"] = "AUBusinessNumber";
+    /** AUCompanyNumber */
     KnownPiiEntityCategory["AUCompanyNumber"] = "AUCompanyNumber";
+    /** ATIdentityCard */
     KnownPiiEntityCategory["ATIdentityCard"] = "ATIdentityCard";
+    /** ATTaxIdentificationNumber */
     KnownPiiEntityCategory["ATTaxIdentificationNumber"] = "ATTaxIdentificationNumber";
+    /** ATValueAddedTaxNumber */
     KnownPiiEntityCategory["ATValueAddedTaxNumber"] = "ATValueAddedTaxNumber";
+    /** AzureDocumentDBAuthKey */
     KnownPiiEntityCategory["AzureDocumentDBAuthKey"] = "AzureDocumentDBAuthKey";
+    /** AzureIaasDatabaseConnectionAndSQLString */
     KnownPiiEntityCategory["AzureIaasDatabaseConnectionAndSQLString"] = "AzureIAASDatabaseConnectionAndSQLString";
+    /** AzureIoTConnectionString */
     KnownPiiEntityCategory["AzureIoTConnectionString"] = "AzureIoTConnectionString";
+    /** AzurePublishSettingPassword */
     KnownPiiEntityCategory["AzurePublishSettingPassword"] = "AzurePublishSettingPassword";
+    /** AzureRedisCacheString */
     KnownPiiEntityCategory["AzureRedisCacheString"] = "AzureRedisCacheString";
+    /** AzureSAS */
     KnownPiiEntityCategory["AzureSAS"] = "AzureSAS";
+    /** AzureServiceBusString */
     KnownPiiEntityCategory["AzureServiceBusString"] = "AzureServiceBusString";
+    /** AzureStorageAccountKey */
     KnownPiiEntityCategory["AzureStorageAccountKey"] = "AzureStorageAccountKey";
+    /** AzureStorageAccountGeneric */
     KnownPiiEntityCategory["AzureStorageAccountGeneric"] = "AzureStorageAccountGeneric";
+    /** BENationalNumber */
     KnownPiiEntityCategory["BENationalNumber"] = "BENationalNumber";
+    /** BENationalNumberV2 */
     KnownPiiEntityCategory["BENationalNumberV2"] = "BENationalNumberV2";
+    /** BEValueAddedTaxNumber */
     KnownPiiEntityCategory["BEValueAddedTaxNumber"] = "BEValueAddedTaxNumber";
+    /** BrcpfNumber */
     KnownPiiEntityCategory["BrcpfNumber"] = "BRCPFNumber";
+    /** BRLegalEntityNumber */
     KnownPiiEntityCategory["BRLegalEntityNumber"] = "BRLegalEntityNumber";
+    /** BRNationalIdrg */
     KnownPiiEntityCategory["BRNationalIdrg"] = "BRNationalIDRG";
+    /** BGUniformCivilNumber */
     KnownPiiEntityCategory["BGUniformCivilNumber"] = "BGUniformCivilNumber";
+    /** CABankAccountNumber */
     KnownPiiEntityCategory["CABankAccountNumber"] = "CABankAccountNumber";
+    /** CADriversLicenseNumber */
     KnownPiiEntityCategory["CADriversLicenseNumber"] = "CADriversLicenseNumber";
+    /** CAHealthServiceNumber */
     KnownPiiEntityCategory["CAHealthServiceNumber"] = "CAHealthServiceNumber";
+    /** CAPassportNumber */
     KnownPiiEntityCategory["CAPassportNumber"] = "CAPassportNumber";
+    /** CAPersonalHealthIdentification */
     KnownPiiEntityCategory["CAPersonalHealthIdentification"] = "CAPersonalHealthIdentification";
+    /** CASocialInsuranceNumber */
     KnownPiiEntityCategory["CASocialInsuranceNumber"] = "CASocialInsuranceNumber";
+    /** CLIdentityCardNumber */
     KnownPiiEntityCategory["CLIdentityCardNumber"] = "CLIdentityCardNumber";
+    /** CNResidentIdentityCardNumber */
     KnownPiiEntityCategory["CNResidentIdentityCardNumber"] = "CNResidentIdentityCardNumber";
+    /** CreditCardNumber */
     KnownPiiEntityCategory["CreditCardNumber"] = "CreditCardNumber";
+    /** HRIdentityCardNumber */
     KnownPiiEntityCategory["HRIdentityCardNumber"] = "HRIdentityCardNumber";
+    /** HRNationalIDNumber */
     KnownPiiEntityCategory["HRNationalIDNumber"] = "HRNationalIDNumber";
+    /** HRPersonalIdentificationNumber */
     KnownPiiEntityCategory["HRPersonalIdentificationNumber"] = "HRPersonalIdentificationNumber";
+    /** HRPersonalIdentificationOIBNumberV2 */
     KnownPiiEntityCategory["HRPersonalIdentificationOIBNumberV2"] = "HRPersonalIdentificationOIBNumberV2";
+    /** CYIdentityCard */
     KnownPiiEntityCategory["CYIdentityCard"] = "CYIdentityCard";
+    /** CYTaxIdentificationNumber */
     KnownPiiEntityCategory["CYTaxIdentificationNumber"] = "CYTaxIdentificationNumber";
+    /** CZPersonalIdentityNumber */
     KnownPiiEntityCategory["CZPersonalIdentityNumber"] = "CZPersonalIdentityNumber";
+    /** CZPersonalIdentityV2 */
     KnownPiiEntityCategory["CZPersonalIdentityV2"] = "CZPersonalIdentityV2";
+    /** DKPersonalIdentificationNumber */
     KnownPiiEntityCategory["DKPersonalIdentificationNumber"] = "DKPersonalIdentificationNumber";
+    /** DKPersonalIdentificationV2 */
     KnownPiiEntityCategory["DKPersonalIdentificationV2"] = "DKPersonalIdentificationV2";
+    /** DrugEnforcementAgencyNumber */
     KnownPiiEntityCategory["DrugEnforcementAgencyNumber"] = "DrugEnforcementAgencyNumber";
+    /** EEPersonalIdentificationCode */
     KnownPiiEntityCategory["EEPersonalIdentificationCode"] = "EEPersonalIdentificationCode";
+    /** EUDebitCardNumber */
     KnownPiiEntityCategory["EUDebitCardNumber"] = "EUDebitCardNumber";
+    /** EUDriversLicenseNumber */
     KnownPiiEntityCategory["EUDriversLicenseNumber"] = "EUDriversLicenseNumber";
+    /** EugpsCoordinates */
     KnownPiiEntityCategory["EugpsCoordinates"] = "EUGPSCoordinates";
+    /** EUNationalIdentificationNumber */
     KnownPiiEntityCategory["EUNationalIdentificationNumber"] = "EUNationalIdentificationNumber";
+    /** EUPassportNumber */
     KnownPiiEntityCategory["EUPassportNumber"] = "EUPassportNumber";
+    /** EUSocialSecurityNumber */
     KnownPiiEntityCategory["EUSocialSecurityNumber"] = "EUSocialSecurityNumber";
+    /** EUTaxIdentificationNumber */
     KnownPiiEntityCategory["EUTaxIdentificationNumber"] = "EUTaxIdentificationNumber";
+    /** FIEuropeanHealthNumber */
     KnownPiiEntityCategory["FIEuropeanHealthNumber"] = "FIEuropeanHealthNumber";
+    /** FINationalID */
     KnownPiiEntityCategory["FINationalID"] = "FINationalID";
+    /** FINationalIDV2 */
     KnownPiiEntityCategory["FINationalIDV2"] = "FINationalIDV2";
+    /** FIPassportNumber */
     KnownPiiEntityCategory["FIPassportNumber"] = "FIPassportNumber";
+    /** FRDriversLicenseNumber */
     KnownPiiEntityCategory["FRDriversLicenseNumber"] = "FRDriversLicenseNumber";
+    /** FRHealthInsuranceNumber */
     KnownPiiEntityCategory["FRHealthInsuranceNumber"] = "FRHealthInsuranceNumber";
+    /** FRNationalID */
     KnownPiiEntityCategory["FRNationalID"] = "FRNationalID";
+    /** FRPassportNumber */
     KnownPiiEntityCategory["FRPassportNumber"] = "FRPassportNumber";
+    /** FRSocialSecurityNumber */
     KnownPiiEntityCategory["FRSocialSecurityNumber"] = "FRSocialSecurityNumber";
+    /** FRTaxIdentificationNumber */
     KnownPiiEntityCategory["FRTaxIdentificationNumber"] = "FRTaxIdentificationNumber";
+    /** FRValueAddedTaxNumber */
     KnownPiiEntityCategory["FRValueAddedTaxNumber"] = "FRValueAddedTaxNumber";
+    /** DEDriversLicenseNumber */
     KnownPiiEntityCategory["DEDriversLicenseNumber"] = "DEDriversLicenseNumber";
+    /** DEPassportNumber */
     KnownPiiEntityCategory["DEPassportNumber"] = "DEPassportNumber";
+    /** DEIdentityCardNumber */
     KnownPiiEntityCategory["DEIdentityCardNumber"] = "DEIdentityCardNumber";
+    /** DETaxIdentificationNumber */
     KnownPiiEntityCategory["DETaxIdentificationNumber"] = "DETaxIdentificationNumber";
+    /** DEValueAddedNumber */
     KnownPiiEntityCategory["DEValueAddedNumber"] = "DEValueAddedNumber";
+    /** GRNationalIDCard */
     KnownPiiEntityCategory["GRNationalIDCard"] = "GRNationalIDCard";
+    /** GRNationalIDV2 */
     KnownPiiEntityCategory["GRNationalIDV2"] = "GRNationalIDV2";
+    /** GRTaxIdentificationNumber */
     KnownPiiEntityCategory["GRTaxIdentificationNumber"] = "GRTaxIdentificationNumber";
+    /** HKIdentityCardNumber */
     KnownPiiEntityCategory["HKIdentityCardNumber"] = "HKIdentityCardNumber";
+    /** HUValueAddedNumber */
     KnownPiiEntityCategory["HUValueAddedNumber"] = "HUValueAddedNumber";
+    /** HUPersonalIdentificationNumber */
     KnownPiiEntityCategory["HUPersonalIdentificationNumber"] = "HUPersonalIdentificationNumber";
+    /** HUTaxIdentificationNumber */
     KnownPiiEntityCategory["HUTaxIdentificationNumber"] = "HUTaxIdentificationNumber";
+    /** INPermanentAccount */
     KnownPiiEntityCategory["INPermanentAccount"] = "INPermanentAccount";
+    /** INUniqueIdentificationNumber */
     KnownPiiEntityCategory["INUniqueIdentificationNumber"] = "INUniqueIdentificationNumber";
+    /** IDIdentityCardNumber */
     KnownPiiEntityCategory["IDIdentityCardNumber"] = "IDIdentityCardNumber";
+    /** InternationalBankingAccountNumber */
     KnownPiiEntityCategory["InternationalBankingAccountNumber"] = "InternationalBankingAccountNumber";
+    /** IEPersonalPublicServiceNumber */
     KnownPiiEntityCategory["IEPersonalPublicServiceNumber"] = "IEPersonalPublicServiceNumber";
+    /** IEPersonalPublicServiceNumberV2 */
     KnownPiiEntityCategory["IEPersonalPublicServiceNumberV2"] = "IEPersonalPublicServiceNumberV2";
+    /** ILBankAccountNumber */
     KnownPiiEntityCategory["ILBankAccountNumber"] = "ILBankAccountNumber";
+    /** ILNationalID */
     KnownPiiEntityCategory["ILNationalID"] = "ILNationalID";
+    /** ITDriversLicenseNumber */
     KnownPiiEntityCategory["ITDriversLicenseNumber"] = "ITDriversLicenseNumber";
+    /** ITFiscalCode */
     KnownPiiEntityCategory["ITFiscalCode"] = "ITFiscalCode";
+    /** ITValueAddedTaxNumber */
     KnownPiiEntityCategory["ITValueAddedTaxNumber"] = "ITValueAddedTaxNumber";
+    /** JPBankAccountNumber */
     KnownPiiEntityCategory["JPBankAccountNumber"] = "JPBankAccountNumber";
+    /** JPDriversLicenseNumber */
     KnownPiiEntityCategory["JPDriversLicenseNumber"] = "JPDriversLicenseNumber";
+    /** JPPassportNumber */
     KnownPiiEntityCategory["JPPassportNumber"] = "JPPassportNumber";
+    /** JPResidentRegistrationNumber */
     KnownPiiEntityCategory["JPResidentRegistrationNumber"] = "JPResidentRegistrationNumber";
+    /** JPSocialInsuranceNumber */
     KnownPiiEntityCategory["JPSocialInsuranceNumber"] = "JPSocialInsuranceNumber";
+    /** JPMyNumberCorporate */
     KnownPiiEntityCategory["JPMyNumberCorporate"] = "JPMyNumberCorporate";
+    /** JPMyNumberPersonal */
     KnownPiiEntityCategory["JPMyNumberPersonal"] = "JPMyNumberPersonal";
+    /** JPResidenceCardNumber */
     KnownPiiEntityCategory["JPResidenceCardNumber"] = "JPResidenceCardNumber";
+    /** LVPersonalCode */
     KnownPiiEntityCategory["LVPersonalCode"] = "LVPersonalCode";
+    /** LTPersonalCode */
     KnownPiiEntityCategory["LTPersonalCode"] = "LTPersonalCode";
+    /** LUNationalIdentificationNumberNatural */
     KnownPiiEntityCategory["LUNationalIdentificationNumberNatural"] = "LUNationalIdentificationNumberNatural";
+    /** LUNationalIdentificationNumberNonNatural */
     KnownPiiEntityCategory["LUNationalIdentificationNumberNonNatural"] = "LUNationalIdentificationNumberNonNatural";
+    /** MYIdentityCardNumber */
     KnownPiiEntityCategory["MYIdentityCardNumber"] = "MYIdentityCardNumber";
+    /** MTIdentityCardNumber */
     KnownPiiEntityCategory["MTIdentityCardNumber"] = "MTIdentityCardNumber";
+    /** MTTaxIDNumber */
     KnownPiiEntityCategory["MTTaxIDNumber"] = "MTTaxIDNumber";
+    /** NLCitizensServiceNumber */
     KnownPiiEntityCategory["NLCitizensServiceNumber"] = "NLCitizensServiceNumber";
+    /** NLCitizensServiceNumberV2 */
     KnownPiiEntityCategory["NLCitizensServiceNumberV2"] = "NLCitizensServiceNumberV2";
+    /** NLTaxIdentificationNumber */
     KnownPiiEntityCategory["NLTaxIdentificationNumber"] = "NLTaxIdentificationNumber";
+    /** NLValueAddedTaxNumber */
     KnownPiiEntityCategory["NLValueAddedTaxNumber"] = "NLValueAddedTaxNumber";
+    /** NZBankAccountNumber */
     KnownPiiEntityCategory["NZBankAccountNumber"] = "NZBankAccountNumber";
+    /** NZDriversLicenseNumber */
     KnownPiiEntityCategory["NZDriversLicenseNumber"] = "NZDriversLicenseNumber";
+    /** NZInlandRevenueNumber */
     KnownPiiEntityCategory["NZInlandRevenueNumber"] = "NZInlandRevenueNumber";
+    /** NZMinistryOfHealthNumber */
     KnownPiiEntityCategory["NZMinistryOfHealthNumber"] = "NZMinistryOfHealthNumber";
+    /** NZSocialWelfareNumber */
     KnownPiiEntityCategory["NZSocialWelfareNumber"] = "NZSocialWelfareNumber";
+    /** NOIdentityNumber */
     KnownPiiEntityCategory["NOIdentityNumber"] = "NOIdentityNumber";
+    /** PHUnifiedMultiPurposeIDNumber */
     KnownPiiEntityCategory["PHUnifiedMultiPurposeIDNumber"] = "PHUnifiedMultiPurposeIDNumber";
+    /** PLIdentityCard */
     KnownPiiEntityCategory["PLIdentityCard"] = "PLIdentityCard";
+    /** PLNationalID */
     KnownPiiEntityCategory["PLNationalID"] = "PLNationalID";
+    /** PLNationalIDV2 */
     KnownPiiEntityCategory["PLNationalIDV2"] = "PLNationalIDV2";
+    /** PLPassportNumber */
     KnownPiiEntityCategory["PLPassportNumber"] = "PLPassportNumber";
+    /** PLTaxIdentificationNumber */
     KnownPiiEntityCategory["PLTaxIdentificationNumber"] = "PLTaxIdentificationNumber";
+    /** PlregonNumber */
     KnownPiiEntityCategory["PlregonNumber"] = "PLREGONNumber";
+    /** PTCitizenCardNumber */
     KnownPiiEntityCategory["PTCitizenCardNumber"] = "PTCitizenCardNumber";
+    /** PTCitizenCardNumberV2 */
     KnownPiiEntityCategory["PTCitizenCardNumberV2"] = "PTCitizenCardNumberV2";
+    /** PTTaxIdentificationNumber */
     KnownPiiEntityCategory["PTTaxIdentificationNumber"] = "PTTaxIdentificationNumber";
+    /** ROPersonalNumericalCode */
     KnownPiiEntityCategory["ROPersonalNumericalCode"] = "ROPersonalNumericalCode";
+    /** RUPassportNumberDomestic */
     KnownPiiEntityCategory["RUPassportNumberDomestic"] = "RUPassportNumberDomestic";
+    /** RUPassportNumberInternational */
     KnownPiiEntityCategory["RUPassportNumberInternational"] = "RUPassportNumberInternational";
+    /** SANationalID */
     KnownPiiEntityCategory["SANationalID"] = "SANationalID";
+    /** SGNationalRegistrationIdentityCardNumber */
     KnownPiiEntityCategory["SGNationalRegistrationIdentityCardNumber"] = "SGNationalRegistrationIdentityCardNumber";
+    /** SKPersonalNumber */
     KnownPiiEntityCategory["SKPersonalNumber"] = "SKPersonalNumber";
+    /** SITaxIdentificationNumber */
     KnownPiiEntityCategory["SITaxIdentificationNumber"] = "SITaxIdentificationNumber";
+    /** SIUniqueMasterCitizenNumber */
     KnownPiiEntityCategory["SIUniqueMasterCitizenNumber"] = "SIUniqueMasterCitizenNumber";
+    /** ZAIdentificationNumber */
     KnownPiiEntityCategory["ZAIdentificationNumber"] = "ZAIdentificationNumber";
+    /** KRResidentRegistrationNumber */
     KnownPiiEntityCategory["KRResidentRegistrationNumber"] = "KRResidentRegistrationNumber";
+    /** Esdni */
     KnownPiiEntityCategory["Esdni"] = "ESDNI";
+    /** ESSocialSecurityNumber */
     KnownPiiEntityCategory["ESSocialSecurityNumber"] = "ESSocialSecurityNumber";
+    /** ESTaxIdentificationNumber */
     KnownPiiEntityCategory["ESTaxIdentificationNumber"] = "ESTaxIdentificationNumber";
+    /** SQLServerConnectionString */
     KnownPiiEntityCategory["SQLServerConnectionString"] = "SQLServerConnectionString";
+    /** SENationalID */
     KnownPiiEntityCategory["SENationalID"] = "SENationalID";
+    /** SENationalIDV2 */
     KnownPiiEntityCategory["SENationalIDV2"] = "SENationalIDV2";
+    /** SEPassportNumber */
     KnownPiiEntityCategory["SEPassportNumber"] = "SEPassportNumber";
+    /** SETaxIdentificationNumber */
     KnownPiiEntityCategory["SETaxIdentificationNumber"] = "SETaxIdentificationNumber";
+    /** SwiftCode */
     KnownPiiEntityCategory["SwiftCode"] = "SWIFTCode";
+    /** CHSocialSecurityNumber */
     KnownPiiEntityCategory["CHSocialSecurityNumber"] = "CHSocialSecurityNumber";
+    /** TWNationalID */
     KnownPiiEntityCategory["TWNationalID"] = "TWNationalID";
+    /** TWPassportNumber */
     KnownPiiEntityCategory["TWPassportNumber"] = "TWPassportNumber";
+    /** TWResidentCertificate */
     KnownPiiEntityCategory["TWResidentCertificate"] = "TWResidentCertificate";
+    /** THPopulationIdentificationCode */
     KnownPiiEntityCategory["THPopulationIdentificationCode"] = "THPopulationIdentificationCode";
+    /** TRNationalIdentificationNumber */
     KnownPiiEntityCategory["TRNationalIdentificationNumber"] = "TRNationalIdentificationNumber";
+    /** UKDriversLicenseNumber */
     KnownPiiEntityCategory["UKDriversLicenseNumber"] = "UKDriversLicenseNumber";
+    /** UKElectoralRollNumber */
     KnownPiiEntityCategory["UKElectoralRollNumber"] = "UKElectoralRollNumber";
+    /** UKNationalHealthNumber */
     KnownPiiEntityCategory["UKNationalHealthNumber"] = "UKNationalHealthNumber";
+    /** UKNationalInsuranceNumber */
     KnownPiiEntityCategory["UKNationalInsuranceNumber"] = "UKNationalInsuranceNumber";
+    /** UKUniqueTaxpayerNumber */
     KnownPiiEntityCategory["UKUniqueTaxpayerNumber"] = "UKUniqueTaxpayerNumber";
+    /** UsukPassportNumber */
     KnownPiiEntityCategory["UsukPassportNumber"] = "USUKPassportNumber";
+    /** USBankAccountNumber */
     KnownPiiEntityCategory["USBankAccountNumber"] = "USBankAccountNumber";
+    /** USDriversLicenseNumber */
     KnownPiiEntityCategory["USDriversLicenseNumber"] = "USDriversLicenseNumber";
+    /** USIndividualTaxpayerIdentification */
     KnownPiiEntityCategory["USIndividualTaxpayerIdentification"] = "USIndividualTaxpayerIdentification";
+    /** USSocialSecurityNumber */
     KnownPiiEntityCategory["USSocialSecurityNumber"] = "USSocialSecurityNumber";
+    /** UAPassportNumberDomestic */
     KnownPiiEntityCategory["UAPassportNumberDomestic"] = "UAPassportNumberDomestic";
+    /** UAPassportNumberInternational */
     KnownPiiEntityCategory["UAPassportNumberInternational"] = "UAPassportNumberInternational";
+    /** Organization */
     KnownPiiEntityCategory["Organization"] = "Organization";
+    /** Email */
     KnownPiiEntityCategory["Email"] = "Email";
+    /** URL */
     KnownPiiEntityCategory["URL"] = "URL";
+    /** Age */
     KnownPiiEntityCategory["Age"] = "Age";
+    /** PhoneNumber */
     KnownPiiEntityCategory["PhoneNumber"] = "PhoneNumber";
+    /** IPAddress */
     KnownPiiEntityCategory["IPAddress"] = "IPAddress";
+    /** Date */
     KnownPiiEntityCategory["Date"] = "Date";
+    /** Person */
     KnownPiiEntityCategory["Person"] = "Person";
+    /** Address */
     KnownPiiEntityCategory["Address"] = "Address";
+    /** All */
     KnownPiiEntityCategory["All"] = "All";
+    /** Default */
     KnownPiiEntityCategory["Default"] = "Default";
 })(KnownPiiEntityCategory || (KnownPiiEntityCategory = {}));
 /** Known values of {@link WarningCode} that the service accepts. */
 export var KnownWarningCode;
 (function (KnownWarningCode) {
+    /** LongWordsInDocument */
     KnownWarningCode["LongWordsInDocument"] = "LongWordsInDocument";
+    /** DocumentTruncated */
     KnownWarningCode["DocumentTruncated"] = "DocumentTruncated";
 })(KnownWarningCode || (KnownWarningCode = {}));
 /** Known values of {@link FhirVersion} that the service accepts. */
 export var KnownFhirVersion;
 (function (KnownFhirVersion) {
+    /** Four01 */
     KnownFhirVersion["Four01"] = "4.0.1";
 })(KnownFhirVersion || (KnownFhirVersion = {}));
 /** Known values of {@link HealthcareEntityCategory} that the service accepts. */
 export var KnownHealthcareEntityCategory;
 (function (KnownHealthcareEntityCategory) {
+    /** BodyStructure */
     KnownHealthcareEntityCategory["BodyStructure"] = "BODY_STRUCTURE";
+    /** AGE */
     KnownHealthcareEntityCategory["AGE"] = "AGE";
+    /** Gender */
     KnownHealthcareEntityCategory["Gender"] = "GENDER";
+    /** ExaminationName */
     KnownHealthcareEntityCategory["ExaminationName"] = "EXAMINATION_NAME";
+    /** Date */
     KnownHealthcareEntityCategory["Date"] = "DATE";
+    /** Direction */
     KnownHealthcareEntityCategory["Direction"] = "DIRECTION";
+    /** Frequency */
     KnownHealthcareEntityCategory["Frequency"] = "FREQUENCY";
+    /** MeasurementValue */
     KnownHealthcareEntityCategory["MeasurementValue"] = "MEASUREMENT_VALUE";
+    /** MeasurementUnit */
     KnownHealthcareEntityCategory["MeasurementUnit"] = "MEASUREMENT_UNIT";
+    /** RelationalOperator */
     KnownHealthcareEntityCategory["RelationalOperator"] = "RELATIONAL_OPERATOR";
+    /** Time */
     KnownHealthcareEntityCategory["Time"] = "TIME";
+    /** GeneORProtein */
     KnownHealthcareEntityCategory["GeneORProtein"] = "GENE_OR_PROTEIN";
+    /** Variant */
     KnownHealthcareEntityCategory["Variant"] = "VARIANT";
+    /** AdministrativeEvent */
     KnownHealthcareEntityCategory["AdministrativeEvent"] = "ADMINISTRATIVE_EVENT";
+    /** CareEnvironment */
     KnownHealthcareEntityCategory["CareEnvironment"] = "CARE_ENVIRONMENT";
+    /** HealthcareProfession */
     KnownHealthcareEntityCategory["HealthcareProfession"] = "HEALTHCARE_PROFESSION";
+    /** Diagnosis */
     KnownHealthcareEntityCategory["Diagnosis"] = "DIAGNOSIS";
+    /** SymptomORSign */
     KnownHealthcareEntityCategory["SymptomORSign"] = "SYMPTOM_OR_SIGN";
+    /** ConditionQualifier */
     KnownHealthcareEntityCategory["ConditionQualifier"] = "CONDITION_QUALIFIER";
+    /** MedicationClass */
     KnownHealthcareEntityCategory["MedicationClass"] = "MEDICATION_CLASS";
+    /** MedicationName */
     KnownHealthcareEntityCategory["MedicationName"] = "MEDICATION_NAME";
+    /** Dosage */
     KnownHealthcareEntityCategory["Dosage"] = "DOSAGE";
+    /** MedicationForm */
     KnownHealthcareEntityCategory["MedicationForm"] = "MEDICATION_FORM";
+    /** MedicationRoute */
     KnownHealthcareEntityCategory["MedicationRoute"] = "MEDICATION_ROUTE";
+    /** FamilyRelation */
     KnownHealthcareEntityCategory["FamilyRelation"] = "FAMILY_RELATION";
+    /** TreatmentName */
     KnownHealthcareEntityCategory["TreatmentName"] = "TREATMENT_NAME";
 })(KnownHealthcareEntityCategory || (KnownHealthcareEntityCategory = {}));
 /** Known values of {@link RelationType} that the service accepts. */
 export var KnownRelationType;
 (function (KnownRelationType) {
+    /** Abbreviation */
     KnownRelationType["Abbreviation"] = "Abbreviation";
+    /** DirectionOfBodyStructure */
     KnownRelationType["DirectionOfBodyStructure"] = "DirectionOfBodyStructure";
+    /** DirectionOfCondition */
     KnownRelationType["DirectionOfCondition"] = "DirectionOfCondition";
+    /** DirectionOfExamination */
     KnownRelationType["DirectionOfExamination"] = "DirectionOfExamination";
+    /** DirectionOfTreatment */
     KnownRelationType["DirectionOfTreatment"] = "DirectionOfTreatment";
+    /** DosageOfMedication */
     KnownRelationType["DosageOfMedication"] = "DosageOfMedication";
+    /** FormOfMedication */
     KnownRelationType["FormOfMedication"] = "FormOfMedication";
+    /** FrequencyOfMedication */
     KnownRelationType["FrequencyOfMedication"] = "FrequencyOfMedication";
+    /** FrequencyOfTreatment */
     KnownRelationType["FrequencyOfTreatment"] = "FrequencyOfTreatment";
+    /** QualifierOfCondition */
     KnownRelationType["QualifierOfCondition"] = "QualifierOfCondition";
+    /** RelationOfExamination */
     KnownRelationType["RelationOfExamination"] = "RelationOfExamination";
+    /** RouteOfMedication */
     KnownRelationType["RouteOfMedication"] = "RouteOfMedication";
+    /** TimeOfCondition */
     KnownRelationType["TimeOfCondition"] = "TimeOfCondition";
+    /** TimeOfEvent */
     KnownRelationType["TimeOfEvent"] = "TimeOfEvent";
+    /** TimeOfExamination */
     KnownRelationType["TimeOfExamination"] = "TimeOfExamination";
+    /** TimeOfMedication */
     KnownRelationType["TimeOfMedication"] = "TimeOfMedication";
+    /** TimeOfTreatment */
     KnownRelationType["TimeOfTreatment"] = "TimeOfTreatment";
+    /** UnitOfCondition */
     KnownRelationType["UnitOfCondition"] = "UnitOfCondition";
+    /** UnitOfExamination */
     KnownRelationType["UnitOfExamination"] = "UnitOfExamination";
+    /** ValueOfCondition */
     KnownRelationType["ValueOfCondition"] = "ValueOfCondition";
+    /** ValueOfExamination */
     KnownRelationType["ValueOfExamination"] = "ValueOfExamination";
 })(KnownRelationType || (KnownRelationType = {}));
 /** Known values of {@link ExtractiveSummarizationOrderingCriteria} that the service accepts. */