@azure/ai-text-analytics 6.0.0-alpha.20220526.1 → 6.0.0-alpha.20220627.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +305 -36
- package/dist/index.js.map +1 -1
- package/dist-esm/src/generated/models/index.js +283 -0
- package/dist-esm/src/generated/models/index.js.map +1 -1
- package/dist-esm/src/lro.js +6 -22
- package/dist-esm/src/lro.js.map +1 -1
- package/dist-esm/src/textAnalysisClient.js +10 -16
- package/dist-esm/src/textAnalysisClient.js.map +1 -1
- package/dist-esm/src/transforms.js +9 -1
- package/dist-esm/src/transforms.js.map +1 -1
- package/package.json +2 -2
- package/types/ai-text-analytics.d.ts +228 -22
|
@@ -28,10 +28,10 @@ export declare interface ActionCommon {
|
|
|
28
28
|
}
|
|
29
29
|
|
|
30
30
|
/** Parameters object for a text analysis task using custom models. */
|
|
31
|
-
export declare
|
|
31
|
+
export declare interface ActionCustom extends ActionCommon {
|
|
32
32
|
projectName: string;
|
|
33
33
|
deploymentName: string;
|
|
34
|
-
}
|
|
34
|
+
}
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
37
|
* Action metadata.
|
|
@@ -44,10 +44,10 @@ export declare interface ActionMetadata {
|
|
|
44
44
|
}
|
|
45
45
|
|
|
46
46
|
/** Configuration common to all actions that use prebuilt models. */
|
|
47
|
-
export declare
|
|
47
|
+
export declare interface ActionPrebuilt extends ActionCommon {
|
|
48
48
|
/** The version of the model to be used by the action. */
|
|
49
49
|
modelVersion?: string;
|
|
50
|
-
}
|
|
50
|
+
}
|
|
51
51
|
|
|
52
52
|
/**
|
|
53
53
|
* Type of actions supported by the {@link TextAnalysisClient.analyze} method.
|
|
@@ -292,14 +292,14 @@ export declare interface CustomActionMetadata {
|
|
|
292
292
|
}
|
|
293
293
|
|
|
294
294
|
/** Supported parameters for a Custom Entities task. */
|
|
295
|
-
export declare
|
|
295
|
+
export declare interface CustomEntityRecognitionAction extends ActionCustom {
|
|
296
296
|
/**
|
|
297
297
|
* Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
|
|
298
298
|
*
|
|
299
299
|
* The default is the JavaScript's default which is "Utf16CodeUnit".
|
|
300
300
|
*/
|
|
301
301
|
stringIndexType?: StringIndexType;
|
|
302
|
-
}
|
|
302
|
+
}
|
|
303
303
|
|
|
304
304
|
/** Options for a custom entity recognition batch action. */
|
|
305
305
|
export declare interface CustomEntityRecognitionBatchAction extends AnalyzeBatchActionCommon, CustomEntityRecognitionAction {
|
|
@@ -336,7 +336,8 @@ export declare interface CustomEntityRecognitionSuccessResult extends TextAnalys
|
|
|
336
336
|
}
|
|
337
337
|
|
|
338
338
|
/** Options for a multi-label classification custom action */
|
|
339
|
-
export declare
|
|
339
|
+
export declare interface CustomMultiLabelClassificationAction extends ActionCustom {
|
|
340
|
+
}
|
|
340
341
|
|
|
341
342
|
/** Options for a custom multi-label classification batch action. */
|
|
342
343
|
export declare interface CustomMultiLabelClassificationBatchAction extends AnalyzeBatchActionCommon, CustomMultiLabelClassificationAction {
|
|
@@ -373,7 +374,8 @@ export declare interface CustomMultiLabelClassificationSuccessResult extends Tex
|
|
|
373
374
|
}
|
|
374
375
|
|
|
375
376
|
/** Options for a single-label classification custom action */
|
|
376
|
-
export declare
|
|
377
|
+
export declare interface CustomSingleLabelClassificationAction extends ActionCustom {
|
|
378
|
+
}
|
|
377
379
|
|
|
378
380
|
/** Options for a custom single-label classification batch action. */
|
|
379
381
|
export declare interface CustomSingleLabelClassificationBatchAction extends AnalyzeBatchActionCommon, CustomSingleLabelClassificationAction {
|
|
@@ -464,14 +466,14 @@ export declare interface EntityDataSource {
|
|
|
464
466
|
}
|
|
465
467
|
|
|
466
468
|
/** Options for an entity linking action. */
|
|
467
|
-
export declare
|
|
469
|
+
export declare interface EntityLinkingAction extends ActionPrebuilt {
|
|
468
470
|
/**
|
|
469
471
|
* Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
|
|
470
472
|
*
|
|
471
473
|
* The default is the JavaScript's default which is "Utf16CodeUnit".
|
|
472
474
|
*/
|
|
473
475
|
stringIndexType?: StringIndexType;
|
|
474
|
-
}
|
|
476
|
+
}
|
|
475
477
|
|
|
476
478
|
/** Options for an entity linking batch action. */
|
|
477
479
|
export declare interface EntityLinkingBatchAction extends AnalyzeBatchActionCommon, EntityLinkingAction {
|
|
@@ -508,14 +510,14 @@ export declare interface EntityLinkingSuccessResult extends TextAnalysisSuccessR
|
|
|
508
510
|
}
|
|
509
511
|
|
|
510
512
|
/** Options for an entity recognition action. */
|
|
511
|
-
export declare
|
|
513
|
+
export declare interface EntityRecognitionAction extends ActionPrebuilt {
|
|
512
514
|
/**
|
|
513
515
|
* Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
|
|
514
516
|
*
|
|
515
517
|
* The default is the JavaScript's default which is "Utf16CodeUnit".
|
|
516
518
|
*/
|
|
517
519
|
stringIndexType?: StringIndexType;
|
|
518
|
-
}
|
|
520
|
+
}
|
|
519
521
|
|
|
520
522
|
/** Options for an entity recognition batch action. */
|
|
521
523
|
export declare interface EntityRecognitionBatchAction extends AnalyzeBatchActionCommon, EntityRecognitionAction {
|
|
@@ -552,7 +554,8 @@ export declare interface EntityRecognitionSuccessResult extends TextAnalysisSucc
|
|
|
552
554
|
}
|
|
553
555
|
|
|
554
556
|
/** Supported parameters for an Extractive Summarization task. */
|
|
555
|
-
export declare
|
|
557
|
+
export declare interface ExtractiveSummarizationAction extends ActionPrebuilt {
|
|
558
|
+
/** The max number of sentences to be part of the summary. */
|
|
556
559
|
maxSentenceCount?: number;
|
|
557
560
|
/** The sorting criteria to use for the results of Extractive Summarization. */
|
|
558
561
|
orderBy?: ExtractiveSummarizationOrderingCriteria;
|
|
@@ -562,7 +565,7 @@ export declare type ExtractiveSummarizationAction = ActionPrebuilt & {
|
|
|
562
565
|
* The default is the JavaScript's default which is "Utf16CodeUnit".
|
|
563
566
|
*/
|
|
564
567
|
stringIndexType?: StringIndexType;
|
|
565
|
-
}
|
|
568
|
+
}
|
|
566
569
|
|
|
567
570
|
/** Options for an extractive summarization batch action. */
|
|
568
571
|
export declare interface ExtractiveSummarizationBatchAction extends AnalyzeBatchActionCommon, ExtractiveSummarizationAction {
|
|
@@ -597,7 +600,7 @@ export declare type ExtractiveSummarizationOrderingCriteria = string;
|
|
|
597
600
|
export declare type FhirVersion = string;
|
|
598
601
|
|
|
599
602
|
/** Supported parameters for a Healthcare task. */
|
|
600
|
-
export declare
|
|
603
|
+
export declare interface HealthcareAction extends ActionPrebuilt {
|
|
601
604
|
/** The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html. */
|
|
602
605
|
fhirVersion?: FhirVersion;
|
|
603
606
|
/**
|
|
@@ -606,7 +609,7 @@ export declare type HealthcareAction = ActionPrebuilt & {
|
|
|
606
609
|
* The default is the JavaScript's default which is "Utf16CodeUnit".
|
|
607
610
|
*/
|
|
608
611
|
stringIndexType?: StringIndexType;
|
|
609
|
-
}
|
|
612
|
+
}
|
|
610
613
|
|
|
611
614
|
/** An object that describes metadata about the healthcare entity such as whether it is hypothetical or conditional. */
|
|
612
615
|
export declare interface HealthcareAssertion {
|
|
@@ -780,7 +783,8 @@ export declare interface HealthcareSuccessResult extends TextAnalysisSuccessResu
|
|
|
780
783
|
}
|
|
781
784
|
|
|
782
785
|
/** Options for a key phrase recognition action. */
|
|
783
|
-
export declare
|
|
786
|
+
export declare interface KeyPhraseExtractionAction extends ActionPrebuilt {
|
|
787
|
+
}
|
|
784
788
|
|
|
785
789
|
/** Options for an key phrase extraction batch action. */
|
|
786
790
|
export declare interface KeyPhraseExtractionBatchAction extends AnalyzeBatchActionCommon, KeyPhraseExtractionAction {
|
|
@@ -819,19 +823,33 @@ export declare interface KeyPhraseExtractionSuccessResult extends TextAnalysisSu
|
|
|
819
823
|
|
|
820
824
|
/** Known values of {@link ErrorCode} that the service accepts. */
|
|
821
825
|
export declare enum KnownErrorCode {
|
|
826
|
+
/** InvalidRequest */
|
|
822
827
|
InvalidRequest = "InvalidRequest",
|
|
828
|
+
/** InvalidArgument */
|
|
823
829
|
InvalidArgument = "InvalidArgument",
|
|
830
|
+
/** Unauthorized */
|
|
824
831
|
Unauthorized = "Unauthorized",
|
|
832
|
+
/** Forbidden */
|
|
825
833
|
Forbidden = "Forbidden",
|
|
834
|
+
/** NotFound */
|
|
826
835
|
NotFound = "NotFound",
|
|
836
|
+
/** ProjectNotFound */
|
|
827
837
|
ProjectNotFound = "ProjectNotFound",
|
|
838
|
+
/** OperationNotFound */
|
|
828
839
|
OperationNotFound = "OperationNotFound",
|
|
840
|
+
/** AzureCognitiveSearchNotFound */
|
|
829
841
|
AzureCognitiveSearchNotFound = "AzureCognitiveSearchNotFound",
|
|
842
|
+
/** AzureCognitiveSearchIndexNotFound */
|
|
830
843
|
AzureCognitiveSearchIndexNotFound = "AzureCognitiveSearchIndexNotFound",
|
|
844
|
+
/** TooManyRequests */
|
|
831
845
|
TooManyRequests = "TooManyRequests",
|
|
846
|
+
/** AzureCognitiveSearchThrottling */
|
|
832
847
|
AzureCognitiveSearchThrottling = "AzureCognitiveSearchThrottling",
|
|
848
|
+
/** AzureCognitiveSearchIndexLimitReached */
|
|
833
849
|
AzureCognitiveSearchIndexLimitReached = "AzureCognitiveSearchIndexLimitReached",
|
|
850
|
+
/** InternalServerError */
|
|
834
851
|
InternalServerError = "InternalServerError",
|
|
852
|
+
/** ServiceUnavailable */
|
|
835
853
|
ServiceUnavailable = "ServiceUnavailable"
|
|
836
854
|
}
|
|
837
855
|
|
|
@@ -853,196 +871,383 @@ export declare enum KnownFhirVersion {
|
|
|
853
871
|
|
|
854
872
|
/** Known values of {@link InnerErrorCode} that the service accepts. */
|
|
855
873
|
export declare enum KnownInnerErrorCode {
|
|
874
|
+
/** InvalidRequest */
|
|
856
875
|
InvalidRequest = "InvalidRequest",
|
|
876
|
+
/** InvalidParameterValue */
|
|
857
877
|
InvalidParameterValue = "InvalidParameterValue",
|
|
878
|
+
/** KnowledgeBaseNotFound */
|
|
858
879
|
KnowledgeBaseNotFound = "KnowledgeBaseNotFound",
|
|
880
|
+
/** AzureCognitiveSearchNotFound */
|
|
859
881
|
AzureCognitiveSearchNotFound = "AzureCognitiveSearchNotFound",
|
|
882
|
+
/** AzureCognitiveSearchThrottling */
|
|
860
883
|
AzureCognitiveSearchThrottling = "AzureCognitiveSearchThrottling",
|
|
884
|
+
/** ExtractionFailure */
|
|
861
885
|
ExtractionFailure = "ExtractionFailure",
|
|
886
|
+
/** InvalidRequestBodyFormat */
|
|
862
887
|
InvalidRequestBodyFormat = "InvalidRequestBodyFormat",
|
|
888
|
+
/** EmptyRequest */
|
|
863
889
|
EmptyRequest = "EmptyRequest",
|
|
890
|
+
/** MissingInputDocuments */
|
|
864
891
|
MissingInputDocuments = "MissingInputDocuments",
|
|
892
|
+
/** InvalidDocument */
|
|
865
893
|
InvalidDocument = "InvalidDocument",
|
|
894
|
+
/** ModelVersionIncorrect */
|
|
866
895
|
ModelVersionIncorrect = "ModelVersionIncorrect",
|
|
896
|
+
/** InvalidDocumentBatch */
|
|
867
897
|
InvalidDocumentBatch = "InvalidDocumentBatch",
|
|
898
|
+
/** UnsupportedLanguageCode */
|
|
868
899
|
UnsupportedLanguageCode = "UnsupportedLanguageCode",
|
|
900
|
+
/** InvalidCountryHint */
|
|
869
901
|
InvalidCountryHint = "InvalidCountryHint"
|
|
870
902
|
}
|
|
871
903
|
|
|
872
904
|
/** Known values of {@link PiiEntityCategory} that the service accepts. */
|
|
873
905
|
export declare enum KnownPiiEntityCategory {
|
|
906
|
+
/** ABARoutingNumber */
|
|
874
907
|
ABARoutingNumber = "ABARoutingNumber",
|
|
908
|
+
/** ARNationalIdentityNumber */
|
|
875
909
|
ARNationalIdentityNumber = "ARNationalIdentityNumber",
|
|
910
|
+
/** AUBankAccountNumber */
|
|
876
911
|
AUBankAccountNumber = "AUBankAccountNumber",
|
|
912
|
+
/** AUDriversLicenseNumber */
|
|
877
913
|
AUDriversLicenseNumber = "AUDriversLicenseNumber",
|
|
914
|
+
/** AUMedicalAccountNumber */
|
|
878
915
|
AUMedicalAccountNumber = "AUMedicalAccountNumber",
|
|
916
|
+
/** AUPassportNumber */
|
|
879
917
|
AUPassportNumber = "AUPassportNumber",
|
|
918
|
+
/** AUTaxFileNumber */
|
|
880
919
|
AUTaxFileNumber = "AUTaxFileNumber",
|
|
920
|
+
/** AUBusinessNumber */
|
|
881
921
|
AUBusinessNumber = "AUBusinessNumber",
|
|
922
|
+
/** AUCompanyNumber */
|
|
882
923
|
AUCompanyNumber = "AUCompanyNumber",
|
|
924
|
+
/** ATIdentityCard */
|
|
883
925
|
ATIdentityCard = "ATIdentityCard",
|
|
926
|
+
/** ATTaxIdentificationNumber */
|
|
884
927
|
ATTaxIdentificationNumber = "ATTaxIdentificationNumber",
|
|
928
|
+
/** ATValueAddedTaxNumber */
|
|
885
929
|
ATValueAddedTaxNumber = "ATValueAddedTaxNumber",
|
|
930
|
+
/** AzureDocumentDBAuthKey */
|
|
886
931
|
AzureDocumentDBAuthKey = "AzureDocumentDBAuthKey",
|
|
932
|
+
/** AzureIaasDatabaseConnectionAndSQLString */
|
|
887
933
|
AzureIaasDatabaseConnectionAndSQLString = "AzureIAASDatabaseConnectionAndSQLString",
|
|
934
|
+
/** AzureIoTConnectionString */
|
|
888
935
|
AzureIoTConnectionString = "AzureIoTConnectionString",
|
|
936
|
+
/** AzurePublishSettingPassword */
|
|
889
937
|
AzurePublishSettingPassword = "AzurePublishSettingPassword",
|
|
938
|
+
/** AzureRedisCacheString */
|
|
890
939
|
AzureRedisCacheString = "AzureRedisCacheString",
|
|
940
|
+
/** AzureSAS */
|
|
891
941
|
AzureSAS = "AzureSAS",
|
|
942
|
+
/** AzureServiceBusString */
|
|
892
943
|
AzureServiceBusString = "AzureServiceBusString",
|
|
944
|
+
/** AzureStorageAccountKey */
|
|
893
945
|
AzureStorageAccountKey = "AzureStorageAccountKey",
|
|
946
|
+
/** AzureStorageAccountGeneric */
|
|
894
947
|
AzureStorageAccountGeneric = "AzureStorageAccountGeneric",
|
|
948
|
+
/** BENationalNumber */
|
|
895
949
|
BENationalNumber = "BENationalNumber",
|
|
950
|
+
/** BENationalNumberV2 */
|
|
896
951
|
BENationalNumberV2 = "BENationalNumberV2",
|
|
952
|
+
/** BEValueAddedTaxNumber */
|
|
897
953
|
BEValueAddedTaxNumber = "BEValueAddedTaxNumber",
|
|
954
|
+
/** BrcpfNumber */
|
|
898
955
|
BrcpfNumber = "BRCPFNumber",
|
|
956
|
+
/** BRLegalEntityNumber */
|
|
899
957
|
BRLegalEntityNumber = "BRLegalEntityNumber",
|
|
958
|
+
/** BRNationalIdrg */
|
|
900
959
|
BRNationalIdrg = "BRNationalIDRG",
|
|
960
|
+
/** BGUniformCivilNumber */
|
|
901
961
|
BGUniformCivilNumber = "BGUniformCivilNumber",
|
|
962
|
+
/** CABankAccountNumber */
|
|
902
963
|
CABankAccountNumber = "CABankAccountNumber",
|
|
964
|
+
/** CADriversLicenseNumber */
|
|
903
965
|
CADriversLicenseNumber = "CADriversLicenseNumber",
|
|
966
|
+
/** CAHealthServiceNumber */
|
|
904
967
|
CAHealthServiceNumber = "CAHealthServiceNumber",
|
|
968
|
+
/** CAPassportNumber */
|
|
905
969
|
CAPassportNumber = "CAPassportNumber",
|
|
970
|
+
/** CAPersonalHealthIdentification */
|
|
906
971
|
CAPersonalHealthIdentification = "CAPersonalHealthIdentification",
|
|
972
|
+
/** CASocialInsuranceNumber */
|
|
907
973
|
CASocialInsuranceNumber = "CASocialInsuranceNumber",
|
|
974
|
+
/** CLIdentityCardNumber */
|
|
908
975
|
CLIdentityCardNumber = "CLIdentityCardNumber",
|
|
976
|
+
/** CNResidentIdentityCardNumber */
|
|
909
977
|
CNResidentIdentityCardNumber = "CNResidentIdentityCardNumber",
|
|
978
|
+
/** CreditCardNumber */
|
|
910
979
|
CreditCardNumber = "CreditCardNumber",
|
|
980
|
+
/** HRIdentityCardNumber */
|
|
911
981
|
HRIdentityCardNumber = "HRIdentityCardNumber",
|
|
982
|
+
/** HRNationalIDNumber */
|
|
912
983
|
HRNationalIDNumber = "HRNationalIDNumber",
|
|
984
|
+
/** HRPersonalIdentificationNumber */
|
|
913
985
|
HRPersonalIdentificationNumber = "HRPersonalIdentificationNumber",
|
|
986
|
+
/** HRPersonalIdentificationOIBNumberV2 */
|
|
914
987
|
HRPersonalIdentificationOIBNumberV2 = "HRPersonalIdentificationOIBNumberV2",
|
|
988
|
+
/** CYIdentityCard */
|
|
915
989
|
CYIdentityCard = "CYIdentityCard",
|
|
990
|
+
/** CYTaxIdentificationNumber */
|
|
916
991
|
CYTaxIdentificationNumber = "CYTaxIdentificationNumber",
|
|
992
|
+
/** CZPersonalIdentityNumber */
|
|
917
993
|
CZPersonalIdentityNumber = "CZPersonalIdentityNumber",
|
|
994
|
+
/** CZPersonalIdentityV2 */
|
|
918
995
|
CZPersonalIdentityV2 = "CZPersonalIdentityV2",
|
|
996
|
+
/** DKPersonalIdentificationNumber */
|
|
919
997
|
DKPersonalIdentificationNumber = "DKPersonalIdentificationNumber",
|
|
998
|
+
/** DKPersonalIdentificationV2 */
|
|
920
999
|
DKPersonalIdentificationV2 = "DKPersonalIdentificationV2",
|
|
1000
|
+
/** DrugEnforcementAgencyNumber */
|
|
921
1001
|
DrugEnforcementAgencyNumber = "DrugEnforcementAgencyNumber",
|
|
1002
|
+
/** EEPersonalIdentificationCode */
|
|
922
1003
|
EEPersonalIdentificationCode = "EEPersonalIdentificationCode",
|
|
1004
|
+
/** EUDebitCardNumber */
|
|
923
1005
|
EUDebitCardNumber = "EUDebitCardNumber",
|
|
1006
|
+
/** EUDriversLicenseNumber */
|
|
924
1007
|
EUDriversLicenseNumber = "EUDriversLicenseNumber",
|
|
1008
|
+
/** EugpsCoordinates */
|
|
925
1009
|
EugpsCoordinates = "EUGPSCoordinates",
|
|
1010
|
+
/** EUNationalIdentificationNumber */
|
|
926
1011
|
EUNationalIdentificationNumber = "EUNationalIdentificationNumber",
|
|
1012
|
+
/** EUPassportNumber */
|
|
927
1013
|
EUPassportNumber = "EUPassportNumber",
|
|
1014
|
+
/** EUSocialSecurityNumber */
|
|
928
1015
|
EUSocialSecurityNumber = "EUSocialSecurityNumber",
|
|
1016
|
+
/** EUTaxIdentificationNumber */
|
|
929
1017
|
EUTaxIdentificationNumber = "EUTaxIdentificationNumber",
|
|
1018
|
+
/** FIEuropeanHealthNumber */
|
|
930
1019
|
FIEuropeanHealthNumber = "FIEuropeanHealthNumber",
|
|
1020
|
+
/** FINationalID */
|
|
931
1021
|
FINationalID = "FINationalID",
|
|
1022
|
+
/** FINationalIDV2 */
|
|
932
1023
|
FINationalIDV2 = "FINationalIDV2",
|
|
1024
|
+
/** FIPassportNumber */
|
|
933
1025
|
FIPassportNumber = "FIPassportNumber",
|
|
1026
|
+
/** FRDriversLicenseNumber */
|
|
934
1027
|
FRDriversLicenseNumber = "FRDriversLicenseNumber",
|
|
1028
|
+
/** FRHealthInsuranceNumber */
|
|
935
1029
|
FRHealthInsuranceNumber = "FRHealthInsuranceNumber",
|
|
1030
|
+
/** FRNationalID */
|
|
936
1031
|
FRNationalID = "FRNationalID",
|
|
1032
|
+
/** FRPassportNumber */
|
|
937
1033
|
FRPassportNumber = "FRPassportNumber",
|
|
1034
|
+
/** FRSocialSecurityNumber */
|
|
938
1035
|
FRSocialSecurityNumber = "FRSocialSecurityNumber",
|
|
1036
|
+
/** FRTaxIdentificationNumber */
|
|
939
1037
|
FRTaxIdentificationNumber = "FRTaxIdentificationNumber",
|
|
1038
|
+
/** FRValueAddedTaxNumber */
|
|
940
1039
|
FRValueAddedTaxNumber = "FRValueAddedTaxNumber",
|
|
1040
|
+
/** DEDriversLicenseNumber */
|
|
941
1041
|
DEDriversLicenseNumber = "DEDriversLicenseNumber",
|
|
1042
|
+
/** DEPassportNumber */
|
|
942
1043
|
DEPassportNumber = "DEPassportNumber",
|
|
1044
|
+
/** DEIdentityCardNumber */
|
|
943
1045
|
DEIdentityCardNumber = "DEIdentityCardNumber",
|
|
1046
|
+
/** DETaxIdentificationNumber */
|
|
944
1047
|
DETaxIdentificationNumber = "DETaxIdentificationNumber",
|
|
1048
|
+
/** DEValueAddedNumber */
|
|
945
1049
|
DEValueAddedNumber = "DEValueAddedNumber",
|
|
1050
|
+
/** GRNationalIDCard */
|
|
946
1051
|
GRNationalIDCard = "GRNationalIDCard",
|
|
1052
|
+
/** GRNationalIDV2 */
|
|
947
1053
|
GRNationalIDV2 = "GRNationalIDV2",
|
|
1054
|
+
/** GRTaxIdentificationNumber */
|
|
948
1055
|
GRTaxIdentificationNumber = "GRTaxIdentificationNumber",
|
|
1056
|
+
/** HKIdentityCardNumber */
|
|
949
1057
|
HKIdentityCardNumber = "HKIdentityCardNumber",
|
|
1058
|
+
/** HUValueAddedNumber */
|
|
950
1059
|
HUValueAddedNumber = "HUValueAddedNumber",
|
|
1060
|
+
/** HUPersonalIdentificationNumber */
|
|
951
1061
|
HUPersonalIdentificationNumber = "HUPersonalIdentificationNumber",
|
|
1062
|
+
/** HUTaxIdentificationNumber */
|
|
952
1063
|
HUTaxIdentificationNumber = "HUTaxIdentificationNumber",
|
|
1064
|
+
/** INPermanentAccount */
|
|
953
1065
|
INPermanentAccount = "INPermanentAccount",
|
|
1066
|
+
/** INUniqueIdentificationNumber */
|
|
954
1067
|
INUniqueIdentificationNumber = "INUniqueIdentificationNumber",
|
|
1068
|
+
/** IDIdentityCardNumber */
|
|
955
1069
|
IDIdentityCardNumber = "IDIdentityCardNumber",
|
|
1070
|
+
/** InternationalBankingAccountNumber */
|
|
956
1071
|
InternationalBankingAccountNumber = "InternationalBankingAccountNumber",
|
|
1072
|
+
/** IEPersonalPublicServiceNumber */
|
|
957
1073
|
IEPersonalPublicServiceNumber = "IEPersonalPublicServiceNumber",
|
|
1074
|
+
/** IEPersonalPublicServiceNumberV2 */
|
|
958
1075
|
IEPersonalPublicServiceNumberV2 = "IEPersonalPublicServiceNumberV2",
|
|
1076
|
+
/** ILBankAccountNumber */
|
|
959
1077
|
ILBankAccountNumber = "ILBankAccountNumber",
|
|
1078
|
+
/** ILNationalID */
|
|
960
1079
|
ILNationalID = "ILNationalID",
|
|
1080
|
+
/** ITDriversLicenseNumber */
|
|
961
1081
|
ITDriversLicenseNumber = "ITDriversLicenseNumber",
|
|
1082
|
+
/** ITFiscalCode */
|
|
962
1083
|
ITFiscalCode = "ITFiscalCode",
|
|
1084
|
+
/** ITValueAddedTaxNumber */
|
|
963
1085
|
ITValueAddedTaxNumber = "ITValueAddedTaxNumber",
|
|
1086
|
+
/** JPBankAccountNumber */
|
|
964
1087
|
JPBankAccountNumber = "JPBankAccountNumber",
|
|
1088
|
+
/** JPDriversLicenseNumber */
|
|
965
1089
|
JPDriversLicenseNumber = "JPDriversLicenseNumber",
|
|
1090
|
+
/** JPPassportNumber */
|
|
966
1091
|
JPPassportNumber = "JPPassportNumber",
|
|
1092
|
+
/** JPResidentRegistrationNumber */
|
|
967
1093
|
JPResidentRegistrationNumber = "JPResidentRegistrationNumber",
|
|
1094
|
+
/** JPSocialInsuranceNumber */
|
|
968
1095
|
JPSocialInsuranceNumber = "JPSocialInsuranceNumber",
|
|
1096
|
+
/** JPMyNumberCorporate */
|
|
969
1097
|
JPMyNumberCorporate = "JPMyNumberCorporate",
|
|
1098
|
+
/** JPMyNumberPersonal */
|
|
970
1099
|
JPMyNumberPersonal = "JPMyNumberPersonal",
|
|
1100
|
+
/** JPResidenceCardNumber */
|
|
971
1101
|
JPResidenceCardNumber = "JPResidenceCardNumber",
|
|
1102
|
+
/** LVPersonalCode */
|
|
972
1103
|
LVPersonalCode = "LVPersonalCode",
|
|
1104
|
+
/** LTPersonalCode */
|
|
973
1105
|
LTPersonalCode = "LTPersonalCode",
|
|
1106
|
+
/** LUNationalIdentificationNumberNatural */
|
|
974
1107
|
LUNationalIdentificationNumberNatural = "LUNationalIdentificationNumberNatural",
|
|
1108
|
+
/** LUNationalIdentificationNumberNonNatural */
|
|
975
1109
|
LUNationalIdentificationNumberNonNatural = "LUNationalIdentificationNumberNonNatural",
|
|
1110
|
+
/** MYIdentityCardNumber */
|
|
976
1111
|
MYIdentityCardNumber = "MYIdentityCardNumber",
|
|
1112
|
+
/** MTIdentityCardNumber */
|
|
977
1113
|
MTIdentityCardNumber = "MTIdentityCardNumber",
|
|
1114
|
+
/** MTTaxIDNumber */
|
|
978
1115
|
MTTaxIDNumber = "MTTaxIDNumber",
|
|
1116
|
+
/** NLCitizensServiceNumber */
|
|
979
1117
|
NLCitizensServiceNumber = "NLCitizensServiceNumber",
|
|
1118
|
+
/** NLCitizensServiceNumberV2 */
|
|
980
1119
|
NLCitizensServiceNumberV2 = "NLCitizensServiceNumberV2",
|
|
1120
|
+
/** NLTaxIdentificationNumber */
|
|
981
1121
|
NLTaxIdentificationNumber = "NLTaxIdentificationNumber",
|
|
1122
|
+
/** NLValueAddedTaxNumber */
|
|
982
1123
|
NLValueAddedTaxNumber = "NLValueAddedTaxNumber",
|
|
1124
|
+
/** NZBankAccountNumber */
|
|
983
1125
|
NZBankAccountNumber = "NZBankAccountNumber",
|
|
1126
|
+
/** NZDriversLicenseNumber */
|
|
984
1127
|
NZDriversLicenseNumber = "NZDriversLicenseNumber",
|
|
1128
|
+
/** NZInlandRevenueNumber */
|
|
985
1129
|
NZInlandRevenueNumber = "NZInlandRevenueNumber",
|
|
1130
|
+
/** NZMinistryOfHealthNumber */
|
|
986
1131
|
NZMinistryOfHealthNumber = "NZMinistryOfHealthNumber",
|
|
1132
|
+
/** NZSocialWelfareNumber */
|
|
987
1133
|
NZSocialWelfareNumber = "NZSocialWelfareNumber",
|
|
1134
|
+
/** NOIdentityNumber */
|
|
988
1135
|
NOIdentityNumber = "NOIdentityNumber",
|
|
1136
|
+
/** PHUnifiedMultiPurposeIDNumber */
|
|
989
1137
|
PHUnifiedMultiPurposeIDNumber = "PHUnifiedMultiPurposeIDNumber",
|
|
1138
|
+
/** PLIdentityCard */
|
|
990
1139
|
PLIdentityCard = "PLIdentityCard",
|
|
1140
|
+
/** PLNationalID */
|
|
991
1141
|
PLNationalID = "PLNationalID",
|
|
1142
|
+
/** PLNationalIDV2 */
|
|
992
1143
|
PLNationalIDV2 = "PLNationalIDV2",
|
|
1144
|
+
/** PLPassportNumber */
|
|
993
1145
|
PLPassportNumber = "PLPassportNumber",
|
|
1146
|
+
/** PLTaxIdentificationNumber */
|
|
994
1147
|
PLTaxIdentificationNumber = "PLTaxIdentificationNumber",
|
|
1148
|
+
/** PlregonNumber */
|
|
995
1149
|
PlregonNumber = "PLREGONNumber",
|
|
1150
|
+
/** PTCitizenCardNumber */
|
|
996
1151
|
PTCitizenCardNumber = "PTCitizenCardNumber",
|
|
1152
|
+
/** PTCitizenCardNumberV2 */
|
|
997
1153
|
PTCitizenCardNumberV2 = "PTCitizenCardNumberV2",
|
|
1154
|
+
/** PTTaxIdentificationNumber */
|
|
998
1155
|
PTTaxIdentificationNumber = "PTTaxIdentificationNumber",
|
|
1156
|
+
/** ROPersonalNumericalCode */
|
|
999
1157
|
ROPersonalNumericalCode = "ROPersonalNumericalCode",
|
|
1158
|
+
/** RUPassportNumberDomestic */
|
|
1000
1159
|
RUPassportNumberDomestic = "RUPassportNumberDomestic",
|
|
1160
|
+
/** RUPassportNumberInternational */
|
|
1001
1161
|
RUPassportNumberInternational = "RUPassportNumberInternational",
|
|
1162
|
+
/** SANationalID */
|
|
1002
1163
|
SANationalID = "SANationalID",
|
|
1164
|
+
/** SGNationalRegistrationIdentityCardNumber */
|
|
1003
1165
|
SGNationalRegistrationIdentityCardNumber = "SGNationalRegistrationIdentityCardNumber",
|
|
1166
|
+
/** SKPersonalNumber */
|
|
1004
1167
|
SKPersonalNumber = "SKPersonalNumber",
|
|
1168
|
+
/** SITaxIdentificationNumber */
|
|
1005
1169
|
SITaxIdentificationNumber = "SITaxIdentificationNumber",
|
|
1170
|
+
/** SIUniqueMasterCitizenNumber */
|
|
1006
1171
|
SIUniqueMasterCitizenNumber = "SIUniqueMasterCitizenNumber",
|
|
1172
|
+
/** ZAIdentificationNumber */
|
|
1007
1173
|
ZAIdentificationNumber = "ZAIdentificationNumber",
|
|
1174
|
+
/** KRResidentRegistrationNumber */
|
|
1008
1175
|
KRResidentRegistrationNumber = "KRResidentRegistrationNumber",
|
|
1176
|
+
/** Esdni */
|
|
1009
1177
|
Esdni = "ESDNI",
|
|
1178
|
+
/** ESSocialSecurityNumber */
|
|
1010
1179
|
ESSocialSecurityNumber = "ESSocialSecurityNumber",
|
|
1180
|
+
/** ESTaxIdentificationNumber */
|
|
1011
1181
|
ESTaxIdentificationNumber = "ESTaxIdentificationNumber",
|
|
1182
|
+
/** SQLServerConnectionString */
|
|
1012
1183
|
SQLServerConnectionString = "SQLServerConnectionString",
|
|
1184
|
+
/** SENationalID */
|
|
1013
1185
|
SENationalID = "SENationalID",
|
|
1186
|
+
/** SENationalIDV2 */
|
|
1014
1187
|
SENationalIDV2 = "SENationalIDV2",
|
|
1188
|
+
/** SEPassportNumber */
|
|
1015
1189
|
SEPassportNumber = "SEPassportNumber",
|
|
1190
|
+
/** SETaxIdentificationNumber */
|
|
1016
1191
|
SETaxIdentificationNumber = "SETaxIdentificationNumber",
|
|
1192
|
+
/** SwiftCode */
|
|
1017
1193
|
SwiftCode = "SWIFTCode",
|
|
1194
|
+
/** CHSocialSecurityNumber */
|
|
1018
1195
|
CHSocialSecurityNumber = "CHSocialSecurityNumber",
|
|
1196
|
+
/** TWNationalID */
|
|
1019
1197
|
TWNationalID = "TWNationalID",
|
|
1198
|
+
/** TWPassportNumber */
|
|
1020
1199
|
TWPassportNumber = "TWPassportNumber",
|
|
1200
|
+
/** TWResidentCertificate */
|
|
1021
1201
|
TWResidentCertificate = "TWResidentCertificate",
|
|
1202
|
+
/** THPopulationIdentificationCode */
|
|
1022
1203
|
THPopulationIdentificationCode = "THPopulationIdentificationCode",
|
|
1204
|
+
/** TRNationalIdentificationNumber */
|
|
1023
1205
|
TRNationalIdentificationNumber = "TRNationalIdentificationNumber",
|
|
1206
|
+
/** UKDriversLicenseNumber */
|
|
1024
1207
|
UKDriversLicenseNumber = "UKDriversLicenseNumber",
|
|
1208
|
+
/** UKElectoralRollNumber */
|
|
1025
1209
|
UKElectoralRollNumber = "UKElectoralRollNumber",
|
|
1210
|
+
/** UKNationalHealthNumber */
|
|
1026
1211
|
UKNationalHealthNumber = "UKNationalHealthNumber",
|
|
1212
|
+
/** UKNationalInsuranceNumber */
|
|
1027
1213
|
UKNationalInsuranceNumber = "UKNationalInsuranceNumber",
|
|
1214
|
+
/** UKUniqueTaxpayerNumber */
|
|
1028
1215
|
UKUniqueTaxpayerNumber = "UKUniqueTaxpayerNumber",
|
|
1216
|
+
/** UsukPassportNumber */
|
|
1029
1217
|
UsukPassportNumber = "USUKPassportNumber",
|
|
1218
|
+
/** USBankAccountNumber */
|
|
1030
1219
|
USBankAccountNumber = "USBankAccountNumber",
|
|
1220
|
+
/** USDriversLicenseNumber */
|
|
1031
1221
|
USDriversLicenseNumber = "USDriversLicenseNumber",
|
|
1222
|
+
/** USIndividualTaxpayerIdentification */
|
|
1032
1223
|
USIndividualTaxpayerIdentification = "USIndividualTaxpayerIdentification",
|
|
1224
|
+
/** USSocialSecurityNumber */
|
|
1033
1225
|
USSocialSecurityNumber = "USSocialSecurityNumber",
|
|
1226
|
+
/** UAPassportNumberDomestic */
|
|
1034
1227
|
UAPassportNumberDomestic = "UAPassportNumberDomestic",
|
|
1228
|
+
/** UAPassportNumberInternational */
|
|
1035
1229
|
UAPassportNumberInternational = "UAPassportNumberInternational",
|
|
1230
|
+
/** Organization */
|
|
1036
1231
|
Organization = "Organization",
|
|
1232
|
+
/** Email */
|
|
1037
1233
|
Email = "Email",
|
|
1234
|
+
/** URL */
|
|
1038
1235
|
URL = "URL",
|
|
1236
|
+
/** Age */
|
|
1039
1237
|
Age = "Age",
|
|
1238
|
+
/** PhoneNumber */
|
|
1040
1239
|
PhoneNumber = "PhoneNumber",
|
|
1240
|
+
/** IPAddress */
|
|
1041
1241
|
IPAddress = "IPAddress",
|
|
1242
|
+
/** Date */
|
|
1042
1243
|
Date = "Date",
|
|
1244
|
+
/** Person */
|
|
1043
1245
|
Person = "Person",
|
|
1246
|
+
/** Address */
|
|
1044
1247
|
Address = "Address",
|
|
1248
|
+
/** All */
|
|
1045
1249
|
All = "All",
|
|
1250
|
+
/** Default */
|
|
1046
1251
|
Default = "Default"
|
|
1047
1252
|
}
|
|
1048
1253
|
|
|
@@ -1096,7 +1301,8 @@ export declare const KnownTextAnalysisErrorCode: {
|
|
|
1096
1301
|
};
|
|
1097
1302
|
|
|
1098
1303
|
/** Options for a language detection action. */
|
|
1099
|
-
export declare
|
|
1304
|
+
export declare interface LanguageDetectionAction extends ActionPrebuilt {
|
|
1305
|
+
}
|
|
1100
1306
|
|
|
1101
1307
|
/**
|
|
1102
1308
|
* An error result from a language detection action on a single document.
|
|
@@ -1375,7 +1581,7 @@ export declare type PiiEntityCategory = string;
|
|
|
1375
1581
|
export declare type PiiEntityDomain = string;
|
|
1376
1582
|
|
|
1377
1583
|
/** Options for a Pii entity recognition action. */
|
|
1378
|
-
export declare
|
|
1584
|
+
export declare interface PiiEntityRecognitionAction extends ActionPrebuilt {
|
|
1379
1585
|
/**
|
|
1380
1586
|
* Filters entities to ones only included in the specified domain (e.g., if set to `Phi`, only entities in the Protected Healthcare Information domain will be returned). For a list of possible domains, see {@link PiiDomain}.
|
|
1381
1587
|
*
|
|
@@ -1390,7 +1596,7 @@ export declare type PiiEntityRecognitionAction = ActionPrebuilt & {
|
|
|
1390
1596
|
* The default is the JavaScript's default which is "Utf16CodeUnit".
|
|
1391
1597
|
*/
|
|
1392
1598
|
stringIndexType?: StringIndexType;
|
|
1393
|
-
}
|
|
1599
|
+
}
|
|
1394
1600
|
|
|
1395
1601
|
/** Options for a pii entity recognition batch action. */
|
|
1396
1602
|
export declare interface PiiEntityRecognitionBatchAction extends AnalyzeBatchActionCommon, PiiEntityRecognitionAction {
|
|
@@ -1512,7 +1718,7 @@ export declare interface SentenceSentiment {
|
|
|
1512
1718
|
export declare type SentenceSentimentLabel = "positive" | "neutral" | "negative";
|
|
1513
1719
|
|
|
1514
1720
|
/** Options for a sentiment analysis action. */
|
|
1515
|
-
export declare
|
|
1721
|
+
export declare interface SentimentAnalysisAction extends ActionPrebuilt {
|
|
1516
1722
|
/** Enables performing opinion mining on the input documents, a more granular analysis around the aspects of a product or service (also known as aspect-based sentiment analysis). If set to true, {@link SentenceSentiment.opinions} will contain the results of this analysis. See {@link https://docs.microsoft.com/azure/cognitive-services/language-service/sentiment-opinion-mining/overview#opinion-mining the service documentation} for more information. */
|
|
1517
1723
|
includeOpinionMining?: boolean;
|
|
1518
1724
|
/**
|
|
@@ -1521,7 +1727,7 @@ export declare type SentimentAnalysisAction = ActionPrebuilt & {
|
|
|
1521
1727
|
* The default is the JavaScript's default which is "Utf16CodeUnit".
|
|
1522
1728
|
*/
|
|
1523
1729
|
stringIndexType?: StringIndexType;
|
|
1524
|
-
}
|
|
1730
|
+
}
|
|
1525
1731
|
|
|
1526
1732
|
/** Options for a sentiment analysis batch action. */
|
|
1527
1733
|
export declare interface SentimentAnalysisBatchAction extends AnalyzeBatchActionCommon, SentimentAnalysisAction {
|