@azure/ai-text-analytics 5.2.0-beta.1 → 5.2.0-beta.2
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/CHANGELOG.md +19 -0
- package/README.md +3 -1
- package/dist/index.js +919 -234
- package/dist/index.js.map +1 -1
- package/dist-esm/src/analyzeActionsResult.js +48 -10
- package/dist-esm/src/analyzeActionsResult.js.map +1 -1
- package/dist-esm/src/analyzeLro.js +18 -16
- package/dist-esm/src/analyzeLro.js.map +1 -1
- package/dist-esm/src/generated/generatedClientContext.js +2 -2
- package/dist-esm/src/generated/generatedClientContext.js.map +1 -1
- package/dist-esm/src/generated/models/index.js.map +1 -1
- package/dist-esm/src/generated/models/mappers.js +620 -1
- package/dist-esm/src/generated/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/models/parameters.js +2 -1
- package/dist-esm/src/generated/models/parameters.js.map +1 -1
- package/dist-esm/src/healthLro.js +23 -15
- package/dist-esm/src/healthLro.js.map +1 -1
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/multiCategoryClassifyResult.js +17 -0
- package/dist-esm/src/multiCategoryClassifyResult.js.map +1 -0
- package/dist-esm/src/multiCategoryClassifyResultArray.js +11 -0
- package/dist-esm/src/multiCategoryClassifyResultArray.js.map +1 -0
- package/dist-esm/src/recognizeCustomEntitiesResult.js +17 -0
- package/dist-esm/src/recognizeCustomEntitiesResult.js.map +1 -0
- package/dist-esm/src/recognizeCustomEntitiesResultArray.js +11 -0
- package/dist-esm/src/recognizeCustomEntitiesResultArray.js.map +1 -0
- package/dist-esm/src/singleCategoryClassifyResult.js +17 -0
- package/dist-esm/src/singleCategoryClassifyResult.js.map +1 -0
- package/dist-esm/src/singleCategoryClassifyResultArray.js +11 -0
- package/dist-esm/src/singleCategoryClassifyResultArray.js.map +1 -0
- package/dist-esm/src/textAnalyticsAction.js.map +1 -1
- package/dist-esm/src/textAnalyticsClient.js +7 -19
- package/dist-esm/src/textAnalyticsClient.js.map +1 -1
- package/dist-esm/src/textAnalyticsResult.js +16 -0
- package/dist-esm/src/textAnalyticsResult.js.map +1 -1
- package/dist-esm/src/util.js +28 -44
- package/dist-esm/src/util.js.map +1 -1
- package/package.json +7 -9
- package/types/ai-text-analytics.d.ts +348 -40
- package/dist-esm/src/paging.js +0 -83
- package/dist-esm/src/paging.js.map +0 -1
- package/dist-esm/src/utils/url.browser.js +0 -6
- package/dist-esm/src/utils/url.browser.js.map +0 -1
- package/dist-esm/src/utils/url.js +0 -4
- package/dist-esm/src/utils/url.js.map +0 -1
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"sdk-type": "client",
|
|
4
4
|
"author": "Microsoft Corporation",
|
|
5
5
|
"description": "An isomorphic client library for the Azure Text Analytics service.",
|
|
6
|
-
"version": "5.2.0-beta.
|
|
6
|
+
"version": "5.2.0-beta.2",
|
|
7
7
|
"keywords": [
|
|
8
8
|
"node",
|
|
9
9
|
"azure",
|
|
@@ -55,7 +55,6 @@
|
|
|
55
55
|
}
|
|
56
56
|
},
|
|
57
57
|
"browser": {
|
|
58
|
-
"./dist-esm/src/utils/url.js": "./dist-esm/src/utils/url.browser.js",
|
|
59
58
|
"./dist-esm/test/public/utils/env.js": "./dist-esm/test/public/utils/env.browser.js"
|
|
60
59
|
},
|
|
61
60
|
"scripts": {
|
|
@@ -64,7 +63,7 @@
|
|
|
64
63
|
"build:node": "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1",
|
|
65
64
|
"build:samples": "echo Obsolete.",
|
|
66
65
|
"build:test": "tsc -p . && rollup -c 2>&1",
|
|
67
|
-
"build": "tsc -p . && rollup -c 2>&1 && api-extractor run --local",
|
|
66
|
+
"build": "npm run clean && tsc -p . && rollup -c 2>&1 && api-extractor run --local",
|
|
68
67
|
"build:debug": "tsc -p . && rollup -c 2>&1 && api-extractor run --local",
|
|
69
68
|
"check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
|
|
70
69
|
"clean": "rimraf dist dist-* temp types *.tgz *.log",
|
|
@@ -77,7 +76,6 @@
|
|
|
77
76
|
"lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
|
|
78
77
|
"lint": "eslint package.json api-extractor.json src test --ext .ts",
|
|
79
78
|
"pack": "npm pack 2>&1",
|
|
80
|
-
"prebuild": "npm run clean",
|
|
81
79
|
"test:browser": "npm run clean && npm run build:test && npm run unit-test:browser",
|
|
82
80
|
"test:node": "npm run clean && npm run build:test && npm run unit-test:node",
|
|
83
81
|
"test": "npm run clean && npm run build:test && npm run unit-test",
|
|
@@ -94,7 +92,7 @@
|
|
|
94
92
|
"@azure/core-client": "^1.0.0",
|
|
95
93
|
"@azure/core-rest-pipeline": "^1.1.0",
|
|
96
94
|
"@azure/core-lro": "^2.2.0",
|
|
97
|
-
"@azure/core-paging": "^1.
|
|
95
|
+
"@azure/core-paging": "^1.2.0",
|
|
98
96
|
"@azure/core-tracing": "1.0.0-preview.13",
|
|
99
97
|
"@azure/logger": "^1.0.0",
|
|
100
98
|
"tslib": "^2.2.0"
|
|
@@ -102,10 +100,10 @@
|
|
|
102
100
|
"devDependencies": {
|
|
103
101
|
"@azure/dev-tool": "^1.0.0",
|
|
104
102
|
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
|
|
105
|
-
"@azure/identity": "2.0.
|
|
103
|
+
"@azure/identity": "^2.0.1",
|
|
106
104
|
"@azure/test-utils": "^1.0.0",
|
|
107
|
-
"@azure/test-
|
|
108
|
-
"@microsoft/api-extractor": "7.
|
|
105
|
+
"@azure-tools/test-recorder": "^1.0.0",
|
|
106
|
+
"@microsoft/api-extractor": "^7.18.11",
|
|
109
107
|
"@types/chai": "^4.1.6",
|
|
110
108
|
"@types/chai-as-promised": "^7.1.0",
|
|
111
109
|
"@types/mocha": "^7.0.2",
|
|
@@ -138,7 +136,7 @@
|
|
|
138
136
|
"rollup": "^1.16.3",
|
|
139
137
|
"sinon": "^9.0.2",
|
|
140
138
|
"source-map-support": "^0.5.9",
|
|
141
|
-
"ts-node": "^
|
|
139
|
+
"ts-node": "^10.0.0",
|
|
142
140
|
"typescript": "~4.2.0",
|
|
143
141
|
"typedoc": "0.15.2"
|
|
144
142
|
}
|
|
@@ -74,6 +74,18 @@ export declare interface AnalyzeActionsResult {
|
|
|
74
74
|
* Array of the results for each extract summary action.
|
|
75
75
|
*/
|
|
76
76
|
extractSummaryResults: ExtractSummaryActionResult[];
|
|
77
|
+
/**
|
|
78
|
+
* Array of the results for each recognize custom entities action.
|
|
79
|
+
*/
|
|
80
|
+
recognizeCustomEntitiesResults: RecognizeCustomEntitiesActionResult[];
|
|
81
|
+
/**
|
|
82
|
+
* Array of the results for each custom classify document single category action.
|
|
83
|
+
*/
|
|
84
|
+
singleCategoryClassifyResults: SingleCategoryClassifyActionResult[];
|
|
85
|
+
/**
|
|
86
|
+
* Array of the results for each custom classify document multi category action.
|
|
87
|
+
*/
|
|
88
|
+
multiCategoryClassifyResults: MultiCategoryClassifyActionResult[];
|
|
77
89
|
}
|
|
78
90
|
|
|
79
91
|
/**
|
|
@@ -240,6 +252,7 @@ export declare interface AnalyzeSentimentSuccessResult extends TextAnalyticsSucc
|
|
|
240
252
|
*/
|
|
241
253
|
export declare interface AssessmentSentiment extends SentenceAssessment {
|
|
242
254
|
}
|
|
255
|
+
|
|
243
256
|
export { AzureKeyCredential }
|
|
244
257
|
|
|
245
258
|
/**
|
|
@@ -289,6 +302,39 @@ export declare interface BeginAnalyzeHealthcareEntitiesOptions extends TextAnaly
|
|
|
289
302
|
export declare interface CategorizedEntity extends Entity {
|
|
290
303
|
}
|
|
291
304
|
|
|
305
|
+
/**
|
|
306
|
+
* A classification result from a custom classify document single category action
|
|
307
|
+
*/
|
|
308
|
+
export declare interface ClassificationCategory extends ClassificationResult {
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
export declare interface ClassificationResult {
|
|
312
|
+
/** Classification type. */
|
|
313
|
+
category: string;
|
|
314
|
+
/** Confidence score between 0 and 1 of the recognized classification. */
|
|
315
|
+
confidenceScore: number;
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* The type of a custom text analytics action.
|
|
320
|
+
*/
|
|
321
|
+
export declare interface CustomTextAnalyticsAction {
|
|
322
|
+
/**
|
|
323
|
+
* The project name for the text analytics model used by this operation on this
|
|
324
|
+
* batch of input documents.
|
|
325
|
+
*/
|
|
326
|
+
projectName: string;
|
|
327
|
+
/**
|
|
328
|
+
* The deployment name for the text analytics model used by this operation on this
|
|
329
|
+
* batch of input documents.
|
|
330
|
+
*/
|
|
331
|
+
deploymentName: string;
|
|
332
|
+
/**
|
|
333
|
+
* The preferred name for this action.
|
|
334
|
+
*/
|
|
335
|
+
actionName?: string;
|
|
336
|
+
}
|
|
337
|
+
|
|
292
338
|
/** Information about the language of a document as identified by the Text Analytics service. */
|
|
293
339
|
export declare interface DetectedLanguage {
|
|
294
340
|
/** Long name of a detected language (e.g. English, French). */
|
|
@@ -524,7 +570,7 @@ export declare interface ExtractSummaryAction extends TextAnalyticsAction {
|
|
|
524
570
|
*/
|
|
525
571
|
maxSentenceCount?: number;
|
|
526
572
|
/**
|
|
527
|
-
* Specifies how to sort the returned sentences. Please refer to {@link
|
|
573
|
+
* Specifies how to sort the returned sentences. Please refer to {@link KnownSummarySentencesOrderBy} for possible values.
|
|
528
574
|
*/
|
|
529
575
|
orderBy?: string;
|
|
530
576
|
}
|
|
@@ -799,7 +845,7 @@ export declare enum KnownInnerErrorCodeValue {
|
|
|
799
845
|
/**
|
|
800
846
|
* A type representing how to sort sentences for the summarization extraction action.
|
|
801
847
|
*/
|
|
802
|
-
export declare type
|
|
848
|
+
export declare type KnownSummarySentencesOrderBy = "Offset" | "Rank";
|
|
803
849
|
|
|
804
850
|
/** Known values of {@link WarningCode} that the service accepts. */
|
|
805
851
|
export declare enum KnownWarningCode {
|
|
@@ -837,6 +883,83 @@ export declare interface Match {
|
|
|
837
883
|
length: number;
|
|
838
884
|
}
|
|
839
885
|
|
|
886
|
+
/**
|
|
887
|
+
* Options for a custom classify document multi categories action. For more information, please refer
|
|
888
|
+
* to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities}
|
|
889
|
+
*/
|
|
890
|
+
export declare interface MultiCategoryClassifyAction extends CustomTextAnalyticsAction {
|
|
891
|
+
/**
|
|
892
|
+
* If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics
|
|
893
|
+
* logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true,
|
|
894
|
+
* disables input logging and may limit our ability to remediate issues that occur.
|
|
895
|
+
*/
|
|
896
|
+
disableServiceLogs?: boolean;
|
|
897
|
+
}
|
|
898
|
+
|
|
899
|
+
/**
|
|
900
|
+
* The error of a custom classify document multi category action.
|
|
901
|
+
*/
|
|
902
|
+
export declare type MultiCategoryClassifyActionErrorResult = TextAnalyticsActionErrorResult;
|
|
903
|
+
|
|
904
|
+
/**
|
|
905
|
+
* The result of a custom classify document multi category action.
|
|
906
|
+
*/
|
|
907
|
+
export declare type MultiCategoryClassifyActionResult = MultiCategoryClassifyActionSuccessResult | MultiCategoryClassifyActionErrorResult;
|
|
908
|
+
|
|
909
|
+
/**
|
|
910
|
+
* The results of a succeeded custom classify document multi category action.
|
|
911
|
+
*/
|
|
912
|
+
export declare interface MultiCategoryClassifyActionSuccessResult extends TextAnalyticsActionSuccessState {
|
|
913
|
+
/**
|
|
914
|
+
* Array of the results for each custom classify document multi category action.
|
|
915
|
+
*/
|
|
916
|
+
results: MultiCategoryClassifyResultArray;
|
|
917
|
+
}
|
|
918
|
+
|
|
919
|
+
/**
|
|
920
|
+
* An error result from the custom classify document multi category operation on a multi document.
|
|
921
|
+
*/
|
|
922
|
+
export declare type MultiCategoryClassifyErrorResult = TextAnalyticsErrorResult;
|
|
923
|
+
|
|
924
|
+
/**
|
|
925
|
+
* The result of the custom classify document multi categories operation on a multi document.
|
|
926
|
+
*/
|
|
927
|
+
export declare type MultiCategoryClassifyResult = MultiCategoryClassifySuccessResult | MultiCategoryClassifyErrorResult;
|
|
928
|
+
|
|
929
|
+
/**
|
|
930
|
+
* Array of `MultiCategoryClassifyResult` objects corresponding to a batch of input documents, and
|
|
931
|
+
* annotated with information about the batch operation.
|
|
932
|
+
*/
|
|
933
|
+
export declare interface MultiCategoryClassifyResultArray extends Array<MultiCategoryClassifyResult> {
|
|
934
|
+
/**
|
|
935
|
+
* Statistics about the input document batch and how it was processed
|
|
936
|
+
* by the service. This property will have a value when includeStatistics is set to true
|
|
937
|
+
* in the client call.
|
|
938
|
+
*/
|
|
939
|
+
statistics?: TextDocumentBatchStatistics;
|
|
940
|
+
/**
|
|
941
|
+
* The version of the text analytics custom project used by this operation on this
|
|
942
|
+
* batch of input documents.
|
|
943
|
+
*/
|
|
944
|
+
projectName: string;
|
|
945
|
+
/**
|
|
946
|
+
* The version of the text analytics custom deployment used by this operation on this
|
|
947
|
+
* batch of input documents.
|
|
948
|
+
*/
|
|
949
|
+
deploymentName: string;
|
|
950
|
+
}
|
|
951
|
+
|
|
952
|
+
/**
|
|
953
|
+
* The result of the custom classify document multi categories operation on a multi document,
|
|
954
|
+
* containing the result of the classification.
|
|
955
|
+
*/
|
|
956
|
+
export declare interface MultiCategoryClassifySuccessResult extends TextAnalyticsSuccessResult {
|
|
957
|
+
/**
|
|
958
|
+
* The collection of classifications in the input document.
|
|
959
|
+
*/
|
|
960
|
+
classifications: ClassificationCategory[];
|
|
961
|
+
}
|
|
962
|
+
|
|
840
963
|
/**
|
|
841
964
|
* Metadata information for an analysis poller operation.
|
|
842
965
|
*/
|
|
@@ -1205,6 +1328,74 @@ export declare interface RecognizeCategorizedEntitiesSuccessResult extends TextA
|
|
|
1205
1328
|
readonly entities: CategorizedEntity[];
|
|
1206
1329
|
}
|
|
1207
1330
|
|
|
1331
|
+
/**
|
|
1332
|
+
* Options for a custom recognize entities action. For more information, please refer
|
|
1333
|
+
* to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customentityrecognition}
|
|
1334
|
+
*/
|
|
1335
|
+
export declare interface RecognizeCustomEntitiesAction extends CustomTextAnalyticsAction {
|
|
1336
|
+
/**
|
|
1337
|
+
* Specifies the measurement unit used to calculate the offset and length properties.
|
|
1338
|
+
* Possible units are "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit".
|
|
1339
|
+
* The default is the JavaScript's default which is "Utf16CodeUnit".
|
|
1340
|
+
*/
|
|
1341
|
+
stringIndexType?: StringIndexType;
|
|
1342
|
+
/**
|
|
1343
|
+
* If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics
|
|
1344
|
+
* logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true,
|
|
1345
|
+
* disables input logging and may limit our ability to remediate issues that occur.
|
|
1346
|
+
*/
|
|
1347
|
+
disableServiceLogs?: boolean;
|
|
1348
|
+
}
|
|
1349
|
+
|
|
1350
|
+
/**
|
|
1351
|
+
* The result of a custom recognize entities action.
|
|
1352
|
+
*/
|
|
1353
|
+
export declare type RecognizeCustomEntitiesActionResult = RecongizeCustomEntitiesActionSuccessResult | RecongizeCustomEntitiesActionErrorResult;
|
|
1354
|
+
|
|
1355
|
+
/**
|
|
1356
|
+
* An error result from the recognize custom entities operation on a single document.
|
|
1357
|
+
*/
|
|
1358
|
+
export declare type RecognizeCustomEntitiesErrorResult = TextAnalyticsErrorResult;
|
|
1359
|
+
|
|
1360
|
+
/**
|
|
1361
|
+
* The result of the custom recognize entities operation on a single document.
|
|
1362
|
+
*/
|
|
1363
|
+
export declare type RecognizeCustomEntitiesResult = RecognizeCustomEntitiesSuccessResult | RecognizeCustomEntitiesErrorResult;
|
|
1364
|
+
|
|
1365
|
+
/**
|
|
1366
|
+
* Array of `CustomRecognizeEntitiesResult` objects corresponding to a batch of input documents, and
|
|
1367
|
+
* annotated with information about the batch operation.
|
|
1368
|
+
*/
|
|
1369
|
+
export declare interface RecognizeCustomEntitiesResultArray extends Array<RecognizeCustomEntitiesResult> {
|
|
1370
|
+
/**
|
|
1371
|
+
* Statistics about the input document batch and how it was processed
|
|
1372
|
+
* by the service. This property will have a value when includeStatistics is set to true
|
|
1373
|
+
* in the client call.
|
|
1374
|
+
*/
|
|
1375
|
+
statistics?: TextDocumentBatchStatistics;
|
|
1376
|
+
/**
|
|
1377
|
+
* The version of the text analytics custom project used by this operation on this
|
|
1378
|
+
* batch of input documents.
|
|
1379
|
+
*/
|
|
1380
|
+
projectName: string;
|
|
1381
|
+
/**
|
|
1382
|
+
* The version of the text analytics custom deployment used by this operation on this
|
|
1383
|
+
* batch of input documents.
|
|
1384
|
+
*/
|
|
1385
|
+
deploymentName: string;
|
|
1386
|
+
}
|
|
1387
|
+
|
|
1388
|
+
/**
|
|
1389
|
+
* The result of the recognize custom entities operation on a single document,
|
|
1390
|
+
* containing a collection of the entities identified in that document.
|
|
1391
|
+
*/
|
|
1392
|
+
export declare interface RecognizeCustomEntitiesSuccessResult extends TextAnalyticsSuccessResult {
|
|
1393
|
+
/**
|
|
1394
|
+
* The collection of entities identified in the input document.
|
|
1395
|
+
*/
|
|
1396
|
+
entities: CategorizedEntity[];
|
|
1397
|
+
}
|
|
1398
|
+
|
|
1208
1399
|
/**
|
|
1209
1400
|
* Options for an entities linking action.
|
|
1210
1401
|
*/
|
|
@@ -1407,6 +1598,21 @@ export declare interface RecognizePiiEntitiesSuccessResult extends TextAnalytics
|
|
|
1407
1598
|
redactedText: string;
|
|
1408
1599
|
}
|
|
1409
1600
|
|
|
1601
|
+
/**
|
|
1602
|
+
* The error of a custom recognize entities action.
|
|
1603
|
+
*/
|
|
1604
|
+
export declare type RecongizeCustomEntitiesActionErrorResult = TextAnalyticsActionErrorResult;
|
|
1605
|
+
|
|
1606
|
+
/**
|
|
1607
|
+
* The results of a succeeded custom recognize entities action.
|
|
1608
|
+
*/
|
|
1609
|
+
export declare interface RecongizeCustomEntitiesActionSuccessResult extends TextAnalyticsActionSuccessState {
|
|
1610
|
+
/**
|
|
1611
|
+
* Array of the results for each custom recognize entities action.
|
|
1612
|
+
*/
|
|
1613
|
+
results: RecognizeCustomEntitiesResultArray;
|
|
1614
|
+
}
|
|
1615
|
+
|
|
1410
1616
|
export declare interface SentenceAssessment {
|
|
1411
1617
|
/** Assessment sentiment in the sentence. */
|
|
1412
1618
|
sentiment: TokenSentimentValue;
|
|
@@ -1465,6 +1671,83 @@ export declare interface SentimentConfidenceScores {
|
|
|
1465
1671
|
negative: number;
|
|
1466
1672
|
}
|
|
1467
1673
|
|
|
1674
|
+
/**
|
|
1675
|
+
* Options for an custom classify document single category action. For more information, please refer
|
|
1676
|
+
* to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities}
|
|
1677
|
+
*/
|
|
1678
|
+
export declare interface SingleCategoryClassifyAction extends CustomTextAnalyticsAction {
|
|
1679
|
+
/**
|
|
1680
|
+
* If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics
|
|
1681
|
+
* logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true,
|
|
1682
|
+
* disables input logging and may limit our ability to remediate issues that occur.
|
|
1683
|
+
*/
|
|
1684
|
+
disableServiceLogs?: boolean;
|
|
1685
|
+
}
|
|
1686
|
+
|
|
1687
|
+
/**
|
|
1688
|
+
* The error of a custom classify document single category action.
|
|
1689
|
+
*/
|
|
1690
|
+
export declare type SingleCategoryClassifyActionErrorResult = TextAnalyticsActionErrorResult;
|
|
1691
|
+
|
|
1692
|
+
/**
|
|
1693
|
+
* The result of a custom classify document single category action.
|
|
1694
|
+
*/
|
|
1695
|
+
export declare type SingleCategoryClassifyActionResult = SingleCategoryClassifyActionSuccessResult | SingleCategoryClassifyActionErrorResult;
|
|
1696
|
+
|
|
1697
|
+
/**
|
|
1698
|
+
* The results of a succeeded custom classify document single category action.
|
|
1699
|
+
*/
|
|
1700
|
+
export declare interface SingleCategoryClassifyActionSuccessResult extends TextAnalyticsActionSuccessState {
|
|
1701
|
+
/**
|
|
1702
|
+
* Array of the results for each custom classify document single category action.
|
|
1703
|
+
*/
|
|
1704
|
+
results: SingleCategoryClassifyResultArray;
|
|
1705
|
+
}
|
|
1706
|
+
|
|
1707
|
+
/**
|
|
1708
|
+
* An error result from the custom classify document single category operation on a single document.
|
|
1709
|
+
*/
|
|
1710
|
+
export declare type SingleCategoryClassifyErrorResult = TextAnalyticsErrorResult;
|
|
1711
|
+
|
|
1712
|
+
/**
|
|
1713
|
+
* The result of the custom classify document single category operation on a single document.
|
|
1714
|
+
*/
|
|
1715
|
+
export declare type SingleCategoryClassifyResult = SingleCategoryClassifySuccessResult | SingleCategoryClassifyErrorResult;
|
|
1716
|
+
|
|
1717
|
+
/**
|
|
1718
|
+
* Array of `SingleCategoryClassifyResult` objects corresponding to a batch of input documents, and
|
|
1719
|
+
* annotated with information about the batch operation.
|
|
1720
|
+
*/
|
|
1721
|
+
export declare interface SingleCategoryClassifyResultArray extends Array<SingleCategoryClassifyResult> {
|
|
1722
|
+
/**
|
|
1723
|
+
* Statistics about the input document batch and how it was processed
|
|
1724
|
+
* by the service. This property will have a value when includeStatistics is set to true
|
|
1725
|
+
* in the client call.
|
|
1726
|
+
*/
|
|
1727
|
+
statistics?: TextDocumentBatchStatistics;
|
|
1728
|
+
/**
|
|
1729
|
+
* The version of the text analytics custom project used by this operation on this
|
|
1730
|
+
* batch of input documents.
|
|
1731
|
+
*/
|
|
1732
|
+
projectName: string;
|
|
1733
|
+
/**
|
|
1734
|
+
* The version of the text analytics custom deployment used by this operation on this
|
|
1735
|
+
* batch of input documents.
|
|
1736
|
+
*/
|
|
1737
|
+
deploymentName: string;
|
|
1738
|
+
}
|
|
1739
|
+
|
|
1740
|
+
/**
|
|
1741
|
+
* The result of the custom classify document single category operation on a single document,
|
|
1742
|
+
* containing the result of the classification.
|
|
1743
|
+
*/
|
|
1744
|
+
export declare interface SingleCategoryClassifySuccessResult extends TextAnalyticsSuccessResult {
|
|
1745
|
+
/**
|
|
1746
|
+
* The classification result of the input document.
|
|
1747
|
+
*/
|
|
1748
|
+
classification: ClassificationCategory;
|
|
1749
|
+
}
|
|
1750
|
+
|
|
1468
1751
|
/**
|
|
1469
1752
|
* Measurement units that can used to calculate the offset and length properties.
|
|
1470
1753
|
*/
|
|
@@ -1522,7 +1805,7 @@ export declare interface TargetSentiment {
|
|
|
1522
1805
|
}
|
|
1523
1806
|
|
|
1524
1807
|
/**
|
|
1525
|
-
* The type of a text analytics action.
|
|
1808
|
+
* The type of a standard text analytics action.
|
|
1526
1809
|
*/
|
|
1527
1810
|
export declare interface TextAnalyticsAction {
|
|
1528
1811
|
/**
|
|
@@ -1539,7 +1822,7 @@ export declare interface TextAnalyticsAction {
|
|
|
1539
1822
|
/**
|
|
1540
1823
|
* The error of an analyze batch action.
|
|
1541
1824
|
*/
|
|
1542
|
-
export declare interface TextAnalyticsActionErrorResult {
|
|
1825
|
+
export declare interface TextAnalyticsActionErrorResult extends TextAnalyticsActionState {
|
|
1543
1826
|
/**
|
|
1544
1827
|
* When this action was completed by the service.
|
|
1545
1828
|
*/
|
|
@@ -1551,39 +1834,64 @@ export declare interface TextAnalyticsActionErrorResult {
|
|
|
1551
1834
|
}
|
|
1552
1835
|
|
|
1553
1836
|
/**
|
|
1554
|
-
* Description of collection of actions for the analyze API to perform on input documents.
|
|
1837
|
+
* Description of collection of actions for the analyze API to perform on input documents.
|
|
1555
1838
|
*/
|
|
1556
1839
|
export declare interface TextAnalyticsActions {
|
|
1557
1840
|
/**
|
|
1558
|
-
* A collection of descriptions of entities recognition actions.
|
|
1841
|
+
* A collection of descriptions of entities recognition actions.
|
|
1559
1842
|
*/
|
|
1560
1843
|
recognizeEntitiesActions?: RecognizeCategorizedEntitiesAction[];
|
|
1561
1844
|
/**
|
|
1562
|
-
* A collection of descriptions of Pii entities recognition actions.
|
|
1845
|
+
* A collection of descriptions of Pii entities recognition actions.
|
|
1563
1846
|
*/
|
|
1564
1847
|
recognizePiiEntitiesActions?: RecognizePiiEntitiesAction[];
|
|
1565
1848
|
/**
|
|
1566
|
-
* A collection of descriptions of key phrases recognition actions.
|
|
1849
|
+
* A collection of descriptions of key phrases recognition actions.
|
|
1567
1850
|
*/
|
|
1568
1851
|
extractKeyPhrasesActions?: ExtractKeyPhrasesAction[];
|
|
1569
1852
|
/**
|
|
1570
|
-
* A collection of descriptions of entities linking actions.
|
|
1853
|
+
* A collection of descriptions of entities linking actions.
|
|
1571
1854
|
*/
|
|
1572
1855
|
recognizeLinkedEntitiesActions?: RecognizeLinkedEntitiesAction[];
|
|
1573
1856
|
/**
|
|
1574
|
-
* A collection of descriptions of sentiment analysis actions.
|
|
1857
|
+
* A collection of descriptions of sentiment analysis actions.
|
|
1575
1858
|
*/
|
|
1576
1859
|
analyzeSentimentActions?: AnalyzeSentimentAction[];
|
|
1577
1860
|
/**
|
|
1578
|
-
* A collection of descriptions of summarization extraction actions.
|
|
1861
|
+
* A collection of descriptions of summarization extraction actions.
|
|
1579
1862
|
*/
|
|
1580
1863
|
extractSummaryActions?: ExtractSummaryAction[];
|
|
1864
|
+
/**
|
|
1865
|
+
* A collection of descriptions of custom entity recognition actions. For more information, please refer
|
|
1866
|
+
* to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customentityrecognition}
|
|
1867
|
+
*/
|
|
1868
|
+
recognizeCustomEntitiesActions?: RecognizeCustomEntitiesAction[];
|
|
1869
|
+
/**
|
|
1870
|
+
* A collection of descriptions of custom single classification actions. For more information, please refer
|
|
1871
|
+
* to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities}
|
|
1872
|
+
*/
|
|
1873
|
+
singleCategoryClassifyActions?: SingleCategoryClassifyAction[];
|
|
1874
|
+
/**
|
|
1875
|
+
* A collection of descriptions of custom multi classification actions. For more information, please refer
|
|
1876
|
+
* to the service documentation: {@link https://aka.ms/azsdk/textanalytics/customfunctionalities}
|
|
1877
|
+
*/
|
|
1878
|
+
multiCategoryClassifyActions?: MultiCategoryClassifyAction[];
|
|
1879
|
+
}
|
|
1880
|
+
|
|
1881
|
+
/**
|
|
1882
|
+
* The state of an action
|
|
1883
|
+
*/
|
|
1884
|
+
export declare interface TextAnalyticsActionState {
|
|
1885
|
+
/**
|
|
1886
|
+
* The name of the action.
|
|
1887
|
+
*/
|
|
1888
|
+
actionName?: string;
|
|
1581
1889
|
}
|
|
1582
1890
|
|
|
1583
1891
|
/**
|
|
1584
1892
|
* The state of a succeeded action.
|
|
1585
1893
|
*/
|
|
1586
|
-
export declare interface TextAnalyticsActionSuccessState {
|
|
1894
|
+
export declare interface TextAnalyticsActionSuccessState extends TextAnalyticsActionState {
|
|
1587
1895
|
/**
|
|
1588
1896
|
* When this action was completed by the service.
|
|
1589
1897
|
*/
|
|
@@ -1665,10 +1973,10 @@ export declare class TextAnalyticsClient {
|
|
|
1665
1973
|
* {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
|
|
1666
1974
|
* @param documents - The input strings to analyze.
|
|
1667
1975
|
* @param language - The language that all the input strings are
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
|
-
|
|
1671
|
-
|
|
1976
|
+
written in. If unspecified, this value will be set to the default
|
|
1977
|
+
language in `TextAnalyticsClientOptions`.
|
|
1978
|
+
If set to an empty string, the service will apply a model
|
|
1979
|
+
where the language is explicitly set to "None".
|
|
1672
1980
|
* @param options - Optional parameters for the operation.
|
|
1673
1981
|
*/
|
|
1674
1982
|
recognizeEntities(documents: string[], language?: string, options?: RecognizeCategorizedEntitiesOptions): Promise<RecognizeCategorizedEntitiesResultArray>;
|
|
@@ -1693,10 +2001,10 @@ export declare class TextAnalyticsClient {
|
|
|
1693
2001
|
* {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
|
|
1694
2002
|
* @param documents - The input strings to analyze.
|
|
1695
2003
|
* @param language - The language that all the input strings are
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
2004
|
+
written in. If unspecified, this value will be set to the default
|
|
2005
|
+
language in `TextAnalyticsClientOptions`.
|
|
2006
|
+
If set to an empty string, the service will apply a model
|
|
2007
|
+
where the lanuage is explicitly set to "None".
|
|
1700
2008
|
* @param options - Optional parameters that includes enabling opinion mining.
|
|
1701
2009
|
*/
|
|
1702
2010
|
analyzeSentiment(documents: string[], language?: string, options?: AnalyzeSentimentOptions): Promise<AnalyzeSentimentResultArray>;
|
|
@@ -1718,10 +2026,10 @@ export declare class TextAnalyticsClient {
|
|
|
1718
2026
|
* {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
|
|
1719
2027
|
* @param documents - The input strings to analyze.
|
|
1720
2028
|
* @param language - The language that all the input strings are
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
2029
|
+
written in. If unspecified, this value will be set to the default
|
|
2030
|
+
language in `TextAnalyticsClientOptions`.
|
|
2031
|
+
If set to an empty string, the service will apply a model
|
|
2032
|
+
where the language is explicitly set to "None".
|
|
1725
2033
|
* @param options - Options for the operation.
|
|
1726
2034
|
*/
|
|
1727
2035
|
extractKeyPhrases(documents: string[], language?: string, options?: ExtractKeyPhrasesOptions): Promise<ExtractKeyPhrasesResultArray>;
|
|
@@ -1743,10 +2051,10 @@ export declare class TextAnalyticsClient {
|
|
|
1743
2051
|
* {@link https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/language-support}.
|
|
1744
2052
|
* @param inputs - The input strings to analyze.
|
|
1745
2053
|
* @param language - The language that all the input strings are
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
|
|
2054
|
+
written in. If unspecified, this value will be set to the default
|
|
2055
|
+
language in `TextAnalyticsClientOptions`.
|
|
2056
|
+
If set to an empty string, the service will apply a model
|
|
2057
|
+
where the language is explicitly set to "None".
|
|
1750
2058
|
* @param options - Options for the operation.
|
|
1751
2059
|
*/
|
|
1752
2060
|
recognizePiiEntities(inputs: string[], language?: string, options?: RecognizePiiEntitiesOptions): Promise<RecognizePiiEntitiesResultArray>;
|
|
@@ -1769,10 +2077,10 @@ export declare class TextAnalyticsClient {
|
|
|
1769
2077
|
* {@link https://docs.microsoft.com/azure/cognitive-services/text-analytics/language-support}.
|
|
1770
2078
|
* @param documents - The input strings to analyze.
|
|
1771
2079
|
* @param language - The language that all the input strings are
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
|
|
2080
|
+
written in. If unspecified, this value will be set to the default
|
|
2081
|
+
language in `TextAnalyticsClientOptions`.
|
|
2082
|
+
If set to an empty string, the service will apply a model
|
|
2083
|
+
where the language is explicitly set to "None".
|
|
1776
2084
|
* @param options - Options for the operation.
|
|
1777
2085
|
*/
|
|
1778
2086
|
recognizeLinkedEntities(documents: string[], language?: string, options?: RecognizeLinkedEntitiesOptions): Promise<RecognizeLinkedEntitiesResultArray>;
|
|
@@ -1791,10 +2099,10 @@ export declare class TextAnalyticsClient {
|
|
|
1791
2099
|
* symptoms, etc) and their relations.
|
|
1792
2100
|
* @param documents - Collection of documents to analyze.
|
|
1793
2101
|
* @param language - The language that all the input strings are
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
2102
|
+
written in. If unspecified, this value will be set to the default
|
|
2103
|
+
language in `TextAnalyticsClientOptions`.
|
|
2104
|
+
If set to an empty string, the service will apply a model
|
|
2105
|
+
where the language is explicitly set to "None".
|
|
1798
2106
|
* @param options - Options for the operation.
|
|
1799
2107
|
*/
|
|
1800
2108
|
beginAnalyzeHealthcareEntities(documents: string[], language?: string, options?: BeginAnalyzeHealthcareEntitiesOptions): Promise<AnalyzeHealthcareEntitiesPollerLike>;
|
|
@@ -1810,10 +2118,10 @@ export declare class TextAnalyticsClient {
|
|
|
1810
2118
|
* @param documents - Collection of documents to analyze
|
|
1811
2119
|
* @param actions - TextAnalyticsActions to execute.
|
|
1812
2120
|
* @param language - The language that all the input strings are
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
|
|
2121
|
+
written in. If unspecified, this value will be set to the default
|
|
2122
|
+
language in `TextAnalyticsClientOptions`.
|
|
2123
|
+
If set to an empty string, the service will apply a model
|
|
2124
|
+
where the language is explicitly set to "None".
|
|
1817
2125
|
* @param options - Options for the operation.
|
|
1818
2126
|
*/
|
|
1819
2127
|
beginAnalyzeActions(documents: string[], actions: TextAnalyticsActions, language?: string, options?: BeginAnalyzeActionsOptions): Promise<AnalyzeActionsPollerLike>;
|