@azure/ai-language-text 1.0.1-alpha.20221014.1 → 1.1.0-alpha.20221102.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.
@@ -17,6 +17,60 @@ import { PagedAsyncIterableIterator } from '@azure/core-paging';
17
17
  import { SimplePollerLike } from '@azure/core-lro';
18
18
  import { TokenCredential } from '@azure/core-auth';
19
19
 
20
+ /** Options for an Abstractive Summarization action. */
21
+ export declare interface AbstractiveSummarizationAction {
22
+ /** The max number of sentences to be part of the summary. */
23
+ maxSentenceCount?: number;
24
+ /**
25
+ * Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
26
+ *
27
+ * The default is the JavaScript's default which is "Utf16CodeUnit".
28
+ */
29
+ stringIndexType?: StringIndexType;
30
+ }
31
+
32
+ /** Options for an abstractive summarization batch action. */
33
+ export declare interface AbstractiveSummarizationBatchAction extends AnalyzeBatchActionCommon, AbstractiveSummarizationAction {
34
+ /**
35
+ * The kind of the action.
36
+ */
37
+ kind: "AbstractiveSummarization";
38
+ }
39
+
40
+ /**
41
+ * The result of an abstractive summarization batch action.
42
+ */
43
+ export declare type AbstractiveSummarizationBatchResult = ActionMetadata & BatchActionResult<AbstractiveSummarizationResult, "AbstractiveSummarization">;
44
+
45
+ /**
46
+ * An error result from the abstractive summarization action on a single document.
47
+ */
48
+ export declare type AbstractiveSummarizationErrorResult = TextAnalysisErrorResult;
49
+
50
+ /**
51
+ * The result of the abstractive summarization action on a single document.
52
+ */
53
+ export declare type AbstractiveSummarizationResult = AbstractiveSummarizationSuccessResult | AbstractiveSummarizationErrorResult;
54
+
55
+ /**
56
+ * The result of the abstractive summarization action on a single document,
57
+ * containing a collection of the summaries identified for that document.
58
+ */
59
+ export declare interface AbstractiveSummarizationSuccessResult extends TextAnalysisSuccessResult {
60
+ /**
61
+ * A list of summaries of the input document.
62
+ */
63
+ readonly summaries: AbstractiveSummary[];
64
+ }
65
+
66
+ /** An object representing a single summary with context for given document. */
67
+ export declare interface AbstractiveSummary {
68
+ /** The text of the summary. */
69
+ text: string;
70
+ /** The context list of the summary. */
71
+ contexts?: SummaryContext[];
72
+ }
73
+
20
74
  /** Configuration common to all actions. */
21
75
  export declare interface ActionCommon {
22
76
  /**
@@ -51,6 +105,27 @@ export declare interface ActionPrebuilt extends ActionCommon {
51
105
  modelVersion?: string;
52
106
  }
53
107
 
108
+ /** Represents the Age entity resolution model. */
109
+ export declare interface AgeResolution extends BaseResolution, QuantityResolution {
110
+ /** Polymorphic discriminator, which specifies the different types this object can be */
111
+ resolutionKind: "AgeResolution";
112
+ /** The Age Unit of measurement */
113
+ unit: AgeUnit;
114
+ }
115
+
116
+ /**
117
+ * Defines values for AgeUnit. \
118
+ * {@link KnownAgeUnit} can be used interchangeably with AgeUnit,
119
+ * this enum contains the known values that the service supports.
120
+ * ### Known values supported by the service
121
+ * **Unspecified** \
122
+ * **Year** \
123
+ * **Month** \
124
+ * **Week** \
125
+ * **Day**
126
+ */
127
+ export declare type AgeUnit = string;
128
+
54
129
  /**
55
130
  * Type of actions supported by the {@link TextAnalysisClient.analyze} method.
56
131
  */
@@ -66,6 +141,7 @@ export declare const AnalyzeActionNames: {
66
141
  readonly PiiEntityRecognition: "PiiEntityRecognition";
67
142
  readonly LanguageDetection: "LanguageDetection";
68
143
  readonly SentimentAnalysis: "SentimentAnalysis";
144
+ readonly DynamicClassification: "DynamicClassification";
69
145
  };
70
146
 
71
147
  /**
@@ -77,13 +153,14 @@ export declare type AnalyzeActionParameters<ActionName extends AnalyzeActionName
77
153
  PiiEntityRecognition: PiiEntityRecognitionAction;
78
154
  KeyPhraseExtraction: KeyPhraseExtractionAction;
79
155
  SentimentAnalysis: SentimentAnalysisAction;
156
+ DynamicClassification: DynamicClassificationAction;
80
157
  LanguageDetection: LanguageDetectionAction;
81
158
  }[ActionName];
82
159
 
83
160
  /**
84
161
  * Batch of actions.
85
162
  */
86
- export declare type AnalyzeBatchAction = EntityLinkingBatchAction | EntityRecognitionBatchAction | KeyPhraseExtractionBatchAction | PiiEntityRecognitionBatchAction | HealthcareBatchAction | SentimentAnalysisBatchAction | CustomEntityRecognitionBatchAction | CustomSingleLabelClassificationBatchAction | CustomMultiLabelClassificationBatchAction;
163
+ export declare type AnalyzeBatchAction = EntityLinkingBatchAction | EntityRecognitionBatchAction | KeyPhraseExtractionBatchAction | PiiEntityRecognitionBatchAction | HealthcareBatchAction | SentimentAnalysisBatchAction | ExtractiveSummarizationBatchAction | AbstractiveSummarizationBatchAction | CustomEntityRecognitionBatchAction | CustomSingleLabelClassificationBatchAction | CustomMultiLabelClassificationBatchAction;
87
164
 
88
165
  /**
89
166
  * Options common to all batch actions.
@@ -110,6 +187,8 @@ export declare const AnalyzeBatchActionNames: {
110
187
  readonly KeyPhraseExtraction: "KeyPhraseExtraction";
111
188
  readonly EntityLinking: "EntityLinking";
112
189
  readonly Healthcare: "Healthcare";
190
+ readonly ExtractiveSummarization: "ExtractiveSummarization";
191
+ readonly AbstractiveSummarization: "AbstractiveSummarization";
113
192
  readonly CustomEntityRecognition: "CustomEntityRecognition";
114
193
  readonly CustomSingleLabelClassification: "CustomSingleLabelClassification";
115
194
  readonly CustomMultiLabelClassification: "CustomMultiLabelClassification";
@@ -167,7 +246,7 @@ export declare type AnalyzeBatchPoller = PollerLike<AnalyzeBatchOperationState,
167
246
  /**
168
247
  * Results of a batch of actions.
169
248
  */
170
- export declare type AnalyzeBatchResult = EntityLinkingBatchResult | EntityRecognitionBatchResult | KeyPhraseExtractionBatchResult | PiiEntityRecognitionBatchResult | SentimentAnalysisBatchResult | HealthcareBatchResult | CustomEntityRecognitionBatchResult | CustomSingleLabelClassificationBatchResult | CustomMultiLabelClassificationBatchResult;
249
+ export declare type AnalyzeBatchResult = EntityLinkingBatchResult | EntityRecognitionBatchResult | KeyPhraseExtractionBatchResult | PiiEntityRecognitionBatchResult | SentimentAnalysisBatchResult | HealthcareBatchResult | ExtractiveSummarizationBatchResult | AbstractiveSummarizationBatchResult | CustomEntityRecognitionBatchResult | CustomSingleLabelClassificationBatchResult | CustomMultiLabelClassificationBatchResult;
171
250
 
172
251
  /**
173
252
  * The type of results of every action in ${@link AnalyzeActionNames}.
@@ -178,9 +257,39 @@ export declare type AnalyzeResult<ActionName extends AnalyzeActionName> = {
178
257
  PiiEntityRecognition: PiiEntityRecognitionResult[];
179
258
  KeyPhraseExtraction: KeyPhraseExtractionResult[];
180
259
  SentimentAnalysis: SentimentAnalysisResult[];
260
+ DynamicClassification: DynamicClassificationResult[];
181
261
  LanguageDetection: LanguageDetectionResult[];
182
262
  }[ActionName];
183
263
 
264
+ /** Represents the area entity resolution model. */
265
+ export declare interface AreaResolution extends BaseResolution, QuantityResolution {
266
+ /** Polymorphic discriminator, which specifies the different types this object can be */
267
+ resolutionKind: "AreaResolution";
268
+ /** The area Unit of measurement */
269
+ unit: AreaUnit;
270
+ }
271
+
272
+ /**
273
+ * Defines values for AreaUnit. \
274
+ * {@link KnownAreaUnit} can be used interchangeably with AreaUnit,
275
+ * this enum contains the known values that the service supports.
276
+ * ### Known values supported by the service
277
+ * **Unspecified** \
278
+ * **SquareKilometer** \
279
+ * **SquareHectometer** \
280
+ * **SquareDecameter** \
281
+ * **SquareDecimeter** \
282
+ * **SquareMeter** \
283
+ * **SquareCentimeter** \
284
+ * **SquareMillimeter** \
285
+ * **SquareInch** \
286
+ * **SquareFoot** \
287
+ * **SquareMile** \
288
+ * **SquareYard** \
289
+ * **Acre**
290
+ */
291
+ export declare type AreaUnit = string;
292
+
184
293
  /** An object that contains the predicted sentiment, confidence scores and other information about an assessment of a target. For example, in the sentence "The food is good", the assessment of the target 'food' is 'good'. */
185
294
  export declare interface AssessmentSentiment {
186
295
  /** Assessment sentiment in the sentence. */
@@ -199,6 +308,14 @@ export declare interface AssessmentSentiment {
199
308
 
200
309
  export { AzureKeyCredential }
201
310
 
311
+ /** The abstract base class for entity resolutions. */
312
+ export declare interface BaseResolution {
313
+ /** Polymorphic discriminator, which specifies the different types this object can be */
314
+ resolutionKind: "AgeResolution" | "VolumeResolution" | "SpeedResolution" | "AreaResolution" | "LengthResolution" | "InformationResolution" | "TemperatureResolution" | "WeightResolution" | "CurrencyResolution" | "BooleanResolution" | "DateTimeResolution" | "NumberResolution" | "OrdinalResolution" | "TemporalSpanResolution" | "NumericRangeResolution";
315
+ }
316
+
317
+ export declare type BaseResolutionUnion = BaseResolution | AgeResolution | VolumeResolution | SpeedResolution | AreaResolution | LengthResolution | InformationResolution | TemperatureResolution | WeightResolution | CurrencyResolution | BooleanResolution | DateTimeResolution | NumberResolution | OrdinalResolution | TemporalSpanResolution | NumericRangeResolution;
318
+
202
319
  /**
203
320
  * The error of an analyze batch action.
204
321
  */
@@ -241,7 +358,7 @@ export declare interface BatchActionSuccessResult<T, Kind extends AnalyzeBatchAc
241
358
  /**
242
359
  * The list of document results.
243
360
  */
244
- readonly results: T[];
361
+ readonly results: WithDetectedLanguage<T>[];
245
362
  /**
246
363
  * When this action was completed by the service.
247
364
  */
@@ -264,6 +381,17 @@ export declare interface BeginAnalyzeBatchOptions extends TextAnalysisOperationO
264
381
  * The operation's display name.
265
382
  */
266
383
  displayName?: string;
384
+ /**
385
+ * Default language code to use for records requesting automatic language detection
386
+ */
387
+ defaultLanguage?: string;
388
+ }
389
+
390
+ /** A resolution for boolean expressions */
391
+ export declare interface BooleanResolution extends BaseResolution {
392
+ /** Polymorphic discriminator, which specifies the different types this object can be */
393
+ resolutionKind: "BooleanResolution";
394
+ value: boolean;
267
395
  }
268
396
 
269
397
  /** A classification result from a custom classify document single category action */
@@ -274,6 +402,26 @@ export declare interface ClassificationCategory {
274
402
  confidenceScore: number;
275
403
  }
276
404
 
405
+ /**
406
+ * Defines values for ClassificationType. \
407
+ * {@link KnownClassificationType} can be used interchangeably with ClassificationType,
408
+ * this enum contains the known values that the service supports.
409
+ * ### Known values supported by the service
410
+ * **Single** \
411
+ * **Multi**
412
+ */
413
+ export declare type ClassificationType = string;
414
+
415
+ /** Represents the currency entity resolution model. */
416
+ export declare interface CurrencyResolution extends BaseResolution, QuantityResolution {
417
+ /** Polymorphic discriminator, which specifies the different types this object can be */
418
+ resolutionKind: "CurrencyResolution";
419
+ /** The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name. */
420
+ iso4217?: string;
421
+ /** The unit of the amount captured in the extracted entity */
422
+ unit: string;
423
+ }
424
+
277
425
  /**
278
426
  * Custom action metadata.
279
427
  */
@@ -408,6 +556,33 @@ export declare interface CustomSingleLabelClassificationSuccessResult extends Te
408
556
  readonly classifications: ClassificationCategory[];
409
557
  }
410
558
 
559
+ /** A resolution for datetime entity instances. */
560
+ export declare interface DateTimeResolution extends BaseResolution {
561
+ /** Polymorphic discriminator, which specifies the different types this object can be */
562
+ resolutionKind: "DateTimeResolution";
563
+ /** An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) */
564
+ timex: string;
565
+ /** The DateTime SubKind */
566
+ dateTimeSubKind: DateTimeSubKind;
567
+ /** The actual time that the extracted text denote. */
568
+ value: string;
569
+ /** An optional modifier of a date/time instance. */
570
+ modifier?: TemporalModifier;
571
+ }
572
+
573
+ /**
574
+ * Defines values for DateTimeSubKind. \
575
+ * {@link KnownDateTimeSubKind} can be used interchangeably with DateTimeSubKind,
576
+ * this enum contains the known values that the service supports.
577
+ * ### Known values supported by the service
578
+ * **Time** \
579
+ * **Date** \
580
+ * **DateTime** \
581
+ * **Duration** \
582
+ * **Set**
583
+ */
584
+ export declare type DateTimeSubKind = string;
585
+
411
586
  /** Information about the language of a document as identified by the Language service. */
412
587
  export declare interface DetectedLanguage {
413
588
  /** Long name of a detected language (e.g. English, French). */
@@ -416,6 +591,14 @@ export declare interface DetectedLanguage {
416
591
  iso6391Name: string;
417
592
  /** A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. */
418
593
  confidenceScore: number;
594
+ /** Identifies the script of the input document. */
595
+ script?: ScriptKind;
596
+ }
597
+
598
+ /** The auto-detected language of the input document. */
599
+ export declare interface DocumentDetectedLanguage {
600
+ /** If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document. */
601
+ detectedLanguage?: DetectedLanguage;
419
602
  }
420
603
 
421
604
  /** Defines values for DocumentSentimentLabel. */
@@ -429,6 +612,35 @@ export declare interface DocumentWarning {
429
612
  message: string;
430
613
  }
431
614
 
615
+ /** Options for a dynamic classification action. */
616
+ export declare interface DynamicClassificationAction extends ActionPrebuilt {
617
+ /** Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document. */
618
+ classificationType?: ClassificationType;
619
+ /** a list of categories to which input is classified to. */
620
+ categories: string[];
621
+ }
622
+
623
+ /**
624
+ * An error result from a language detection action on a single document.
625
+ */
626
+ export declare type DynamicClassificationErrorResult = TextAnalysisErrorResult;
627
+
628
+ /**
629
+ * The result of a language detection action on a single document.
630
+ */
631
+ export declare type DynamicClassificationResult = DynamicClassificationSuccessResult | DynamicClassificationErrorResult;
632
+
633
+ /**
634
+ * The result of a language detection action on a single document,
635
+ * containing a prediction of what language the document is written in.
636
+ */
637
+ export declare interface DynamicClassificationSuccessResult extends TextAnalysisSuccessResult {
638
+ /**
639
+ * The collection of classifications in the input document.
640
+ */
641
+ readonly classifications: ClassificationCategory[];
642
+ }
643
+
432
644
  /** A word or phrase identified as an entity that is categorized within a taxonomy of types. The set of categories recognized by the Language service is described at https://docs.microsoft.com/azure/cognitive-services/language-service/named-entity-recognition/concepts/named-entity-categories . */
433
645
  export declare interface Entity {
434
646
  /** Entity text as appears in the request. */
@@ -547,11 +759,88 @@ export declare interface EntityRecognitionSuccessResult extends TextAnalysisSucc
547
759
  /**
548
760
  * The collection of entities identified in the input document.
549
761
  */
550
- readonly entities: Entity[];
762
+ readonly entities: EntityWithResolution[];
763
+ }
764
+
765
+ /** An entity with resolution. */
766
+ export declare interface EntityWithResolution extends Entity {
767
+ /** The collection of entity resolution objects. */
768
+ resolutions?: BaseResolutionUnion[];
551
769
  }
552
770
 
771
+ /** Supported parameters for an Extractive Summarization task. */
772
+ export declare interface ExtractiveSummarizationAction extends ActionPrebuilt {
773
+ /** The max number of sentences to be part of the summary. */
774
+ maxSentenceCount?: number;
775
+ /** The sorting criteria to use for the results of Extractive Summarization. */
776
+ orderBy?: ExtractiveSummarizationOrderingCriteria;
777
+ /**
778
+ * Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
779
+ *
780
+ * The default is the JavaScript's default which is "Utf16CodeUnit".
781
+ */
782
+ stringIndexType?: StringIndexType;
783
+ }
784
+
785
+ /** Options for an extractive summarization batch action. */
786
+ export declare interface ExtractiveSummarizationBatchAction extends AnalyzeBatchActionCommon, ExtractiveSummarizationAction {
787
+ /**
788
+ * The kind of the action.
789
+ */
790
+ kind: "ExtractiveSummarization";
791
+ }
792
+
793
+ /**
794
+ * The result of an extractive summarization batch action.
795
+ */
796
+ export declare type ExtractiveSummarizationBatchResult = ActionMetadata & BatchActionResult<ExtractiveSummarizationResult, "ExtractiveSummarization">;
797
+
798
+ /**
799
+ * An error result from the extractive summarization action on a single document.
800
+ */
801
+ export declare type ExtractiveSummarizationErrorResult = TextAnalysisErrorResult;
802
+
803
+ /**
804
+ * Defines values for ExtractiveSummarizationOrderingCriteria. \
805
+ * {@link KnownExtractiveSummarizationOrderingCriteria} can be used interchangeably with ExtractiveSummarizationOrderingCriteria,
806
+ * this enum contains the known values that the service supports.
807
+ * ### Known values supported by the service
808
+ * **Offset**: Indicates that results should be sorted in order of appearance in the text. \
809
+ * **Rank**: Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.
810
+ */
811
+ export declare type ExtractiveSummarizationOrderingCriteria = string;
812
+
813
+ /**
814
+ * The result of the extractive summarization action on a single document.
815
+ */
816
+ export declare type ExtractiveSummarizationResult = ExtractiveSummarizationSuccessResult | ExtractiveSummarizationErrorResult;
817
+
818
+ /**
819
+ * The result of the extractive summarization action on a single document,
820
+ * containing a collection of the summary identified in that document.
821
+ */
822
+ export declare interface ExtractiveSummarizationSuccessResult extends TextAnalysisSuccessResult {
823
+ /**
824
+ * A list of sentences composing a summary of the input document.
825
+ */
826
+ readonly sentences: SummarySentence[];
827
+ }
828
+
829
+ /**
830
+ * Defines values for FhirVersion. \
831
+ * {@link KnownFhirVersion} can be used interchangeably with FhirVersion,
832
+ * this enum contains the known values that the service supports.
833
+ * ### Known values supported by the service
834
+ * **4.0.1**
835
+ */
836
+ export declare type FhirVersion = string;
837
+
553
838
  /** Supported parameters for a Healthcare task. */
554
839
  export declare interface HealthcareAction extends ActionPrebuilt {
840
+ /** The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html. */
841
+ fhirVersion?: FhirVersion;
842
+ /** Document type that can be provided as input for Fhir Documents. Expect to have fhirVersion provided when used. Behavior of using None enum is the same as not using the documentType parameter. */
843
+ documentType?: HealthcareDocumentType;
555
844
  /**
556
845
  * Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see {@link KnownStringIndexType}.
557
846
  *
@@ -583,6 +872,23 @@ export declare interface HealthcareBatchAction extends AnalyzeBatchActionCommon,
583
872
  */
584
873
  export declare type HealthcareBatchResult = ActionMetadata & BatchActionResult<HealthcareResult, "Healthcare">;
585
874
 
875
+ /**
876
+ * Defines values for HealthcareDocumentType. \
877
+ * {@link KnownHealthcareDocumentType} can be used interchangeably with HealthcareDocumentType,
878
+ * this enum contains the known values that the service supports.
879
+ * ### Known values supported by the service
880
+ * **None** \
881
+ * **ClinicalTrial** \
882
+ * **DischargeSummary** \
883
+ * **ProgressNote** \
884
+ * **HistoryAndPhysical** \
885
+ * **Consult** \
886
+ * **Imaging** \
887
+ * **Pathology** \
888
+ * **ProcedureNote**
889
+ */
890
+ export declare type HealthcareDocumentType = string;
891
+
586
892
  /**
587
893
  * A healthcare entity represented as a node in a directed graph where the edges are
588
894
  * a particular type of relationship between the source and target nodes.
@@ -681,6 +987,10 @@ export declare interface HealthcareEntityRelation {
681
987
  * The list of healthcare entities and their roles in the healthcare relation.
682
988
  */
683
989
  readonly roles: HealthcareEntityRelationRole[];
990
+ /**
991
+ * The confidence score between 0 and 1 of the extracted relation.
992
+ */
993
+ readonly confidenceScore?: number;
684
994
  }
685
995
 
686
996
  /**
@@ -724,8 +1034,42 @@ export declare interface HealthcareSuccessResult extends TextAnalysisSuccessResu
724
1034
  * Relations between healthcare entities.
725
1035
  */
726
1036
  readonly entityRelations: HealthcareEntityRelation[];
1037
+ /**
1038
+ * JSON bundle containing a FHIR compatible object for consumption in other
1039
+ * Healthcare tools. For additional information see {@link https://www.hl7.org/fhir/overview.html}.
1040
+ */
1041
+ readonly fhirBundle?: Record<string, any>;
1042
+ }
1043
+
1044
+ /** Represents the information (data) entity resolution model. */
1045
+ export declare interface InformationResolution extends BaseResolution, QuantityResolution {
1046
+ /** Polymorphic discriminator, which specifies the different types this object can be */
1047
+ resolutionKind: "InformationResolution";
1048
+ /** The information (data) Unit of measurement. */
1049
+ unit: InformationUnit;
727
1050
  }
728
1051
 
1052
+ /**
1053
+ * Defines values for InformationUnit. \
1054
+ * {@link KnownInformationUnit} can be used interchangeably with InformationUnit,
1055
+ * this enum contains the known values that the service supports.
1056
+ * ### Known values supported by the service
1057
+ * **Unspecified** \
1058
+ * **Bit** \
1059
+ * **Kilobit** \
1060
+ * **Megabit** \
1061
+ * **Gigabit** \
1062
+ * **Terabit** \
1063
+ * **Petabit** \
1064
+ * **Byte** \
1065
+ * **Kilobyte** \
1066
+ * **Megabyte** \
1067
+ * **Gigabyte** \
1068
+ * **Terabyte** \
1069
+ * **Petabyte**
1070
+ */
1071
+ export declare type InformationUnit = string;
1072
+
729
1073
  /** Options for a key phrase recognition action. */
730
1074
  export declare interface KeyPhraseExtractionAction extends ActionPrebuilt {
731
1075
  }
@@ -765,6 +1109,72 @@ export declare interface KeyPhraseExtractionSuccessResult extends TextAnalysisSu
765
1109
  readonly keyPhrases: string[];
766
1110
  }
767
1111
 
1112
+ /** Known values of {@link AgeUnit} that the service accepts. */
1113
+ export declare enum KnownAgeUnit {
1114
+ /** Unspecified */
1115
+ Unspecified = "Unspecified",
1116
+ /** Year */
1117
+ Year = "Year",
1118
+ /** Month */
1119
+ Month = "Month",
1120
+ /** Week */
1121
+ Week = "Week",
1122
+ /** Day */
1123
+ Day = "Day"
1124
+ }
1125
+
1126
+ /** Known values of {@link AreaUnit} that the service accepts. */
1127
+ export declare enum KnownAreaUnit {
1128
+ /** Unspecified */
1129
+ Unspecified = "Unspecified",
1130
+ /** SquareKilometer */
1131
+ SquareKilometer = "SquareKilometer",
1132
+ /** SquareHectometer */
1133
+ SquareHectometer = "SquareHectometer",
1134
+ /** SquareDecameter */
1135
+ SquareDecameter = "SquareDecameter",
1136
+ /** SquareDecimeter */
1137
+ SquareDecimeter = "SquareDecimeter",
1138
+ /** SquareMeter */
1139
+ SquareMeter = "SquareMeter",
1140
+ /** SquareCentimeter */
1141
+ SquareCentimeter = "SquareCentimeter",
1142
+ /** SquareMillimeter */
1143
+ SquareMillimeter = "SquareMillimeter",
1144
+ /** SquareInch */
1145
+ SquareInch = "SquareInch",
1146
+ /** SquareFoot */
1147
+ SquareFoot = "SquareFoot",
1148
+ /** SquareMile */
1149
+ SquareMile = "SquareMile",
1150
+ /** SquareYard */
1151
+ SquareYard = "SquareYard",
1152
+ /** Acre */
1153
+ Acre = "Acre"
1154
+ }
1155
+
1156
+ /** Known values of {@link ClassificationType} that the service accepts. */
1157
+ export declare enum KnownClassificationType {
1158
+ /** Single */
1159
+ Single = "Single",
1160
+ /** Multi */
1161
+ Multi = "Multi"
1162
+ }
1163
+
1164
+ /** Known values of {@link DateTimeSubKind} that the service accepts. */
1165
+ export declare enum KnownDateTimeSubKind {
1166
+ /** Time */
1167
+ Time = "Time",
1168
+ /** Date */
1169
+ Date = "Date",
1170
+ /** DateTime */
1171
+ DateTime = "DateTime",
1172
+ /** Duration */
1173
+ Duration = "Duration",
1174
+ /** Set */
1175
+ Set = "Set"
1176
+ }
1177
+
768
1178
  /** Known values of {@link ErrorCode} that the service accepts. */
769
1179
  export declare enum KnownErrorCode {
770
1180
  /** InvalidRequest */
@@ -805,6 +1215,130 @@ export declare enum KnownErrorCode {
805
1215
  Warning = "Warning"
806
1216
  }
807
1217
 
1218
+ /** Known values of {@link ExtractiveSummarizationOrderingCriteria} that the service accepts. */
1219
+ export declare enum KnownExtractiveSummarizationOrderingCriteria {
1220
+ /** Indicates that results should be sorted in order of appearance in the text. */
1221
+ Offset = "Offset",
1222
+ /** Indicates that results should be sorted in order of importance (i.e. rank score) according to the model. */
1223
+ Rank = "Rank"
1224
+ }
1225
+
1226
+ /**
1227
+ * Known values of the {@link HealthcareAction.fhirVersion} parameter.
1228
+ */
1229
+ export declare enum KnownFhirVersion {
1230
+ /** 4.0.1 */
1231
+ "4.0.1" = "4.0.1"
1232
+ }
1233
+
1234
+ /** Known values of {@link HealthcareDocumentType} that the service accepts. */
1235
+ export declare enum KnownHealthcareDocumentType {
1236
+ /** None */
1237
+ None = "None",
1238
+ /** ClinicalTrial */
1239
+ ClinicalTrial = "ClinicalTrial",
1240
+ /** DischargeSummary */
1241
+ DischargeSummary = "DischargeSummary",
1242
+ /** ProgressNote */
1243
+ ProgressNote = "ProgressNote",
1244
+ /** HistoryAndPhysical */
1245
+ HistoryAndPhysical = "HistoryAndPhysical",
1246
+ /** Consult */
1247
+ Consult = "Consult",
1248
+ /** Imaging */
1249
+ Imaging = "Imaging",
1250
+ /** Pathology */
1251
+ Pathology = "Pathology",
1252
+ /** ProcedureNote */
1253
+ ProcedureNote = "ProcedureNote"
1254
+ }
1255
+
1256
+ /** Known values of {@link HealthcareEntityCategory} that the service accepts. */
1257
+ export declare enum KnownHealthcareEntityCategory {
1258
+ /** BodyStructure */
1259
+ BodyStructure = "BodyStructure",
1260
+ /** Age */
1261
+ Age = "Age",
1262
+ /** Gender */
1263
+ Gender = "Gender",
1264
+ /** ExaminationName */
1265
+ ExaminationName = "ExaminationName",
1266
+ /** Date */
1267
+ Date = "Date",
1268
+ /** Direction */
1269
+ Direction = "Direction",
1270
+ /** Frequency */
1271
+ Frequency = "Frequency",
1272
+ /** MeasurementValue */
1273
+ MeasurementValue = "MeasurementValue",
1274
+ /** MeasurementUnit */
1275
+ MeasurementUnit = "MeasurementUnit",
1276
+ /** RelationalOperator */
1277
+ RelationalOperator = "RelationalOperator",
1278
+ /** Time */
1279
+ Time = "Time",
1280
+ /** GeneOrProtein */
1281
+ GeneOrProtein = "GeneOrProtein",
1282
+ /** Variant */
1283
+ Variant = "Variant",
1284
+ /** AdministrativeEvent */
1285
+ AdministrativeEvent = "AdministrativeEvent",
1286
+ /** CareEnvironment */
1287
+ CareEnvironment = "CareEnvironment",
1288
+ /** HealthcareProfession */
1289
+ HealthcareProfession = "HealthcareProfession",
1290
+ /** Diagnosis */
1291
+ Diagnosis = "Diagnosis",
1292
+ /** SymptomOrSign */
1293
+ SymptomOrSign = "SymptomOrSign",
1294
+ /** ConditionQualifier */
1295
+ ConditionQualifier = "ConditionQualifier",
1296
+ /** MedicationClass */
1297
+ MedicationClass = "MedicationClass",
1298
+ /** MedicationName */
1299
+ MedicationName = "MedicationName",
1300
+ /** Dosage */
1301
+ Dosage = "Dosage",
1302
+ /** MedicationForm */
1303
+ MedicationForm = "MedicationForm",
1304
+ /** MedicationRoute */
1305
+ MedicationRoute = "MedicationRoute",
1306
+ /** FamilyRelation */
1307
+ FamilyRelation = "FamilyRelation",
1308
+ /** TreatmentName */
1309
+ TreatmentName = "TreatmentName"
1310
+ }
1311
+
1312
+ /** Known values of {@link InformationUnit} that the service accepts. */
1313
+ export declare enum KnownInformationUnit {
1314
+ /** Unspecified */
1315
+ Unspecified = "Unspecified",
1316
+ /** Bit */
1317
+ Bit = "Bit",
1318
+ /** Kilobit */
1319
+ Kilobit = "Kilobit",
1320
+ /** Megabit */
1321
+ Megabit = "Megabit",
1322
+ /** Gigabit */
1323
+ Gigabit = "Gigabit",
1324
+ /** Terabit */
1325
+ Terabit = "Terabit",
1326
+ /** Petabit */
1327
+ Petabit = "Petabit",
1328
+ /** Byte */
1329
+ Byte = "Byte",
1330
+ /** Kilobyte */
1331
+ Kilobyte = "Kilobyte",
1332
+ /** Megabyte */
1333
+ Megabyte = "Megabyte",
1334
+ /** Gigabyte */
1335
+ Gigabyte = "Gigabyte",
1336
+ /** Terabyte */
1337
+ Terabyte = "Terabyte",
1338
+ /** Petabyte */
1339
+ Petabyte = "Petabyte"
1340
+ }
1341
+
808
1342
  /** Known values of {@link InnerErrorCode} that the service accepts. */
809
1343
  export declare enum KnownInnerErrorCode {
810
1344
  /** InvalidRequest */
@@ -837,6 +1371,60 @@ export declare enum KnownInnerErrorCode {
837
1371
  InvalidCountryHint = "InvalidCountryHint"
838
1372
  }
839
1373
 
1374
+ /** Known values of {@link LengthUnit} that the service accepts. */
1375
+ export declare enum KnownLengthUnit {
1376
+ /** Unspecified */
1377
+ Unspecified = "Unspecified",
1378
+ /** Kilometer */
1379
+ Kilometer = "Kilometer",
1380
+ /** Hectometer */
1381
+ Hectometer = "Hectometer",
1382
+ /** Decameter */
1383
+ Decameter = "Decameter",
1384
+ /** Meter */
1385
+ Meter = "Meter",
1386
+ /** Decimeter */
1387
+ Decimeter = "Decimeter",
1388
+ /** Centimeter */
1389
+ Centimeter = "Centimeter",
1390
+ /** Millimeter */
1391
+ Millimeter = "Millimeter",
1392
+ /** Micrometer */
1393
+ Micrometer = "Micrometer",
1394
+ /** Nanometer */
1395
+ Nanometer = "Nanometer",
1396
+ /** Picometer */
1397
+ Picometer = "Picometer",
1398
+ /** Mile */
1399
+ Mile = "Mile",
1400
+ /** Yard */
1401
+ Yard = "Yard",
1402
+ /** Inch */
1403
+ Inch = "Inch",
1404
+ /** Foot */
1405
+ Foot = "Foot",
1406
+ /** LightYear */
1407
+ LightYear = "LightYear",
1408
+ /** Pt */
1409
+ Pt = "Pt"
1410
+ }
1411
+
1412
+ /** Known values of {@link NumberKind} that the service accepts. */
1413
+ export declare enum KnownNumberKind {
1414
+ /** Integer */
1415
+ Integer = "Integer",
1416
+ /** Decimal */
1417
+ Decimal = "Decimal",
1418
+ /** Power */
1419
+ Power = "Power",
1420
+ /** Fraction */
1421
+ Fraction = "Fraction",
1422
+ /** Percent */
1423
+ Percent = "Percent",
1424
+ /** Unspecified */
1425
+ Unspecified = "Unspecified"
1426
+ }
1427
+
840
1428
  /** Known values of {@link PiiEntityCategory} that the service accepts. */
841
1429
  export declare enum KnownPiiEntityCategory {
842
1430
  /** ABARoutingNumber */
@@ -1195,6 +1783,158 @@ export declare enum KnownPiiEntityDomain {
1195
1783
  None = "none"
1196
1784
  }
1197
1785
 
1786
+ /** Known values of {@link RangeKind} that the service accepts. */
1787
+ export declare enum KnownRangeKind {
1788
+ /** Number */
1789
+ Number = "Number",
1790
+ /** Speed */
1791
+ Speed = "Speed",
1792
+ /** Weight */
1793
+ Weight = "Weight",
1794
+ /** Length */
1795
+ Length = "Length",
1796
+ /** Volume */
1797
+ Volume = "Volume",
1798
+ /** Area */
1799
+ Area = "Area",
1800
+ /** Age */
1801
+ Age = "Age",
1802
+ /** Information */
1803
+ Information = "Information",
1804
+ /** Temperature */
1805
+ Temperature = "Temperature",
1806
+ /** Currency */
1807
+ Currency = "Currency"
1808
+ }
1809
+
1810
+ /** Known values of {@link RelationType} that the service accepts. */
1811
+ export declare enum KnownRelationType {
1812
+ /** Abbreviation */
1813
+ Abbreviation = "Abbreviation",
1814
+ /** DirectionOfBodyStructure */
1815
+ DirectionOfBodyStructure = "DirectionOfBodyStructure",
1816
+ /** DirectionOfCondition */
1817
+ DirectionOfCondition = "DirectionOfCondition",
1818
+ /** DirectionOfExamination */
1819
+ DirectionOfExamination = "DirectionOfExamination",
1820
+ /** DirectionOfTreatment */
1821
+ DirectionOfTreatment = "DirectionOfTreatment",
1822
+ /** DosageOfMedication */
1823
+ DosageOfMedication = "DosageOfMedication",
1824
+ /** FormOfMedication */
1825
+ FormOfMedication = "FormOfMedication",
1826
+ /** FrequencyOfMedication */
1827
+ FrequencyOfMedication = "FrequencyOfMedication",
1828
+ /** FrequencyOfTreatment */
1829
+ FrequencyOfTreatment = "FrequencyOfTreatment",
1830
+ /** QualifierOfCondition */
1831
+ QualifierOfCondition = "QualifierOfCondition",
1832
+ /** RelationOfExamination */
1833
+ RelationOfExamination = "RelationOfExamination",
1834
+ /** RouteOfMedication */
1835
+ RouteOfMedication = "RouteOfMedication",
1836
+ /** TimeOfCondition */
1837
+ TimeOfCondition = "TimeOfCondition",
1838
+ /** TimeOfEvent */
1839
+ TimeOfEvent = "TimeOfEvent",
1840
+ /** TimeOfExamination */
1841
+ TimeOfExamination = "TimeOfExamination",
1842
+ /** TimeOfMedication */
1843
+ TimeOfMedication = "TimeOfMedication",
1844
+ /** TimeOfTreatment */
1845
+ TimeOfTreatment = "TimeOfTreatment",
1846
+ /** UnitOfCondition */
1847
+ UnitOfCondition = "UnitOfCondition",
1848
+ /** UnitOfExamination */
1849
+ UnitOfExamination = "UnitOfExamination",
1850
+ /** ValueOfCondition */
1851
+ ValueOfCondition = "ValueOfCondition",
1852
+ /** ValueOfExamination */
1853
+ ValueOfExamination = "ValueOfExamination"
1854
+ }
1855
+
1856
+ /** Known values of {@link RelativeTo} that the service accepts. */
1857
+ export declare enum KnownRelativeTo {
1858
+ /** Current */
1859
+ Current = "Current",
1860
+ /** End */
1861
+ End = "End",
1862
+ /** Start */
1863
+ Start = "Start"
1864
+ }
1865
+
1866
+ /** Known values of {@link ResolutionKind} that the service accepts. */
1867
+ export declare enum KnownResolutionKind {
1868
+ /** BooleanResolution */
1869
+ BooleanResolution = "BooleanResolution",
1870
+ /** DateTimeResolution */
1871
+ DateTimeResolution = "DateTimeResolution",
1872
+ /** NumberResolution */
1873
+ NumberResolution = "NumberResolution",
1874
+ /** OrdinalResolution */
1875
+ OrdinalResolution = "OrdinalResolution",
1876
+ /** SpeedResolution */
1877
+ SpeedResolution = "SpeedResolution",
1878
+ /** WeightResolution */
1879
+ WeightResolution = "WeightResolution",
1880
+ /** LengthResolution */
1881
+ LengthResolution = "LengthResolution",
1882
+ /** VolumeResolution */
1883
+ VolumeResolution = "VolumeResolution",
1884
+ /** AreaResolution */
1885
+ AreaResolution = "AreaResolution",
1886
+ /** AgeResolution */
1887
+ AgeResolution = "AgeResolution",
1888
+ /** InformationResolution */
1889
+ InformationResolution = "InformationResolution",
1890
+ /** TemperatureResolution */
1891
+ TemperatureResolution = "TemperatureResolution",
1892
+ /** CurrencyResolution */
1893
+ CurrencyResolution = "CurrencyResolution",
1894
+ /** NumericRangeResolution */
1895
+ NumericRangeResolution = "NumericRangeResolution",
1896
+ /** TemporalSpanResolution */
1897
+ TemporalSpanResolution = "TemporalSpanResolution"
1898
+ }
1899
+
1900
+ /** Known values of {@link ScriptKind} that the service accepts. */
1901
+ export declare enum KnownScriptKind {
1902
+ /** Latin */
1903
+ Latin = "Latin"
1904
+ }
1905
+
1906
+ /** Known values of {@link SpeedUnit} that the service accepts. */
1907
+ export declare enum KnownSpeedUnit {
1908
+ /** Unspecified */
1909
+ Unspecified = "Unspecified",
1910
+ /** MetersPerSecond */
1911
+ MetersPerSecond = "MetersPerSecond",
1912
+ /** KilometersPerHour */
1913
+ KilometersPerHour = "KilometersPerHour",
1914
+ /** KilometersPerMinute */
1915
+ KilometersPerMinute = "KilometersPerMinute",
1916
+ /** KilometersPerSecond */
1917
+ KilometersPerSecond = "KilometersPerSecond",
1918
+ /** MilesPerHour */
1919
+ MilesPerHour = "MilesPerHour",
1920
+ /** Knot */
1921
+ Knot = "Knot",
1922
+ /** FootPerSecond */
1923
+ FootPerSecond = "FootPerSecond",
1924
+ /** FootPerMinute */
1925
+ FootPerMinute = "FootPerMinute",
1926
+ /** YardsPerMinute */
1927
+ YardsPerMinute = "YardsPerMinute",
1928
+ /** YardsPerSecond */
1929
+ YardsPerSecond = "YardsPerSecond",
1930
+ /** MetersPerMillisecond */
1931
+ MetersPerMillisecond = "MetersPerMillisecond",
1932
+ /** CentimetersPerMillisecond */
1933
+ CentimetersPerMillisecond = "CentimetersPerMillisecond",
1934
+ /** KilometersPerMillisecond */
1935
+ KilometersPerMillisecond = "KilometersPerMillisecond"
1936
+ }
1937
+
1198
1938
  /** Known values of {@link StringIndexType} that the service accepts. */
1199
1939
  export declare enum KnownStringIndexType {
1200
1940
  /** Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo. */
@@ -1205,6 +1945,60 @@ export declare enum KnownStringIndexType {
1205
1945
  Utf16CodeUnit = "Utf16CodeUnit"
1206
1946
  }
1207
1947
 
1948
+ /** Known values of {@link TemperatureUnit} that the service accepts. */
1949
+ export declare enum KnownTemperatureUnit {
1950
+ /** Unspecified */
1951
+ Unspecified = "Unspecified",
1952
+ /** Fahrenheit */
1953
+ Fahrenheit = "Fahrenheit",
1954
+ /** Kelvin */
1955
+ Kelvin = "Kelvin",
1956
+ /** Rankine */
1957
+ Rankine = "Rankine",
1958
+ /** Celsius */
1959
+ Celsius = "Celsius"
1960
+ }
1961
+
1962
+ /** Known values of {@link TemporalModifier} that the service accepts. */
1963
+ export declare enum KnownTemporalModifier {
1964
+ /** AfterApprox */
1965
+ AfterApprox = "AfterApprox",
1966
+ /** Before */
1967
+ Before = "Before",
1968
+ /** BeforeStart */
1969
+ BeforeStart = "BeforeStart",
1970
+ /** Approx */
1971
+ Approx = "Approx",
1972
+ /** ReferenceUndefined */
1973
+ ReferenceUndefined = "ReferenceUndefined",
1974
+ /** SinceEnd */
1975
+ SinceEnd = "SinceEnd",
1976
+ /** AfterMid */
1977
+ AfterMid = "AfterMid",
1978
+ /** Start */
1979
+ Start = "Start",
1980
+ /** After */
1981
+ After = "After",
1982
+ /** BeforeEnd */
1983
+ BeforeEnd = "BeforeEnd",
1984
+ /** Until */
1985
+ Until = "Until",
1986
+ /** End */
1987
+ End = "End",
1988
+ /** Less */
1989
+ Less = "Less",
1990
+ /** Since */
1991
+ Since = "Since",
1992
+ /** AfterStart */
1993
+ AfterStart = "AfterStart",
1994
+ /** BeforeApprox */
1995
+ BeforeApprox = "BeforeApprox",
1996
+ /** Mid */
1997
+ Mid = "Mid",
1998
+ /** More */
1999
+ More = "More"
2000
+ }
2001
+
1208
2002
  /**
1209
2003
  * Enum of possible error codes of a {@link TextAnalysisError}.
1210
2004
  */
@@ -1240,6 +2034,102 @@ export declare const KnownTextAnalysisErrorCode: {
1240
2034
  Warning: KnownErrorCode.Warning;
1241
2035
  };
1242
2036
 
2037
+ /** Known values of {@link VolumeUnit} that the service accepts. */
2038
+ export declare enum KnownVolumeUnit {
2039
+ /** Unspecified */
2040
+ Unspecified = "Unspecified",
2041
+ /** CubicMeter */
2042
+ CubicMeter = "CubicMeter",
2043
+ /** CubicCentimeter */
2044
+ CubicCentimeter = "CubicCentimeter",
2045
+ /** CubicMillimeter */
2046
+ CubicMillimeter = "CubicMillimeter",
2047
+ /** Hectoliter */
2048
+ Hectoliter = "Hectoliter",
2049
+ /** Decaliter */
2050
+ Decaliter = "Decaliter",
2051
+ /** Liter */
2052
+ Liter = "Liter",
2053
+ /** Centiliter */
2054
+ Centiliter = "Centiliter",
2055
+ /** Milliliter */
2056
+ Milliliter = "Milliliter",
2057
+ /** CubicYard */
2058
+ CubicYard = "CubicYard",
2059
+ /** CubicInch */
2060
+ CubicInch = "CubicInch",
2061
+ /** CubicFoot */
2062
+ CubicFoot = "CubicFoot",
2063
+ /** CubicMile */
2064
+ CubicMile = "CubicMile",
2065
+ /** FluidOunce */
2066
+ FluidOunce = "FluidOunce",
2067
+ /** Teaspoon */
2068
+ Teaspoon = "Teaspoon",
2069
+ /** Tablespoon */
2070
+ Tablespoon = "Tablespoon",
2071
+ /** Pint */
2072
+ Pint = "Pint",
2073
+ /** Quart */
2074
+ Quart = "Quart",
2075
+ /** Cup */
2076
+ Cup = "Cup",
2077
+ /** Gill */
2078
+ Gill = "Gill",
2079
+ /** Pinch */
2080
+ Pinch = "Pinch",
2081
+ /** FluidDram */
2082
+ FluidDram = "FluidDram",
2083
+ /** Barrel */
2084
+ Barrel = "Barrel",
2085
+ /** Minim */
2086
+ Minim = "Minim",
2087
+ /** Cord */
2088
+ Cord = "Cord",
2089
+ /** Peck */
2090
+ Peck = "Peck",
2091
+ /** Bushel */
2092
+ Bushel = "Bushel",
2093
+ /** Hogshead */
2094
+ Hogshead = "Hogshead"
2095
+ }
2096
+
2097
+ /** Known values of {@link WeightUnit} that the service accepts. */
2098
+ export declare enum KnownWeightUnit {
2099
+ /** Unspecified */
2100
+ Unspecified = "Unspecified",
2101
+ /** Kilogram */
2102
+ Kilogram = "Kilogram",
2103
+ /** Gram */
2104
+ Gram = "Gram",
2105
+ /** Milligram */
2106
+ Milligram = "Milligram",
2107
+ /** Gallon */
2108
+ Gallon = "Gallon",
2109
+ /** MetricTon */
2110
+ MetricTon = "MetricTon",
2111
+ /** Ton */
2112
+ Ton = "Ton",
2113
+ /** Pound */
2114
+ Pound = "Pound",
2115
+ /** Ounce */
2116
+ Ounce = "Ounce",
2117
+ /** Grain */
2118
+ Grain = "Grain",
2119
+ /** PennyWeight */
2120
+ PennyWeight = "PennyWeight",
2121
+ /** LongTonBritish */
2122
+ LongTonBritish = "LongTonBritish",
2123
+ /** ShortTonUS */
2124
+ ShortTonUS = "ShortTonUS",
2125
+ /** ShortHundredWeightUS */
2126
+ ShortHundredWeightUS = "ShortHundredWeightUS",
2127
+ /** Stone */
2128
+ Stone = "Stone",
2129
+ /** Dram */
2130
+ Dram = "Dram"
2131
+ }
2132
+
1243
2133
  /** Options for a language detection action. */
1244
2134
  export declare interface LanguageDetectionAction extends ActionPrebuilt {
1245
2135
  }
@@ -1275,6 +2165,39 @@ export declare interface LanguageDetectionSuccessResult extends TextAnalysisSucc
1275
2165
  readonly primaryLanguage: DetectedLanguage;
1276
2166
  }
1277
2167
 
2168
+ /** Represents the length entity resolution model. */
2169
+ export declare interface LengthResolution extends BaseResolution, QuantityResolution {
2170
+ /** Polymorphic discriminator, which specifies the different types this object can be */
2171
+ resolutionKind: "LengthResolution";
2172
+ /** The length Unit of measurement */
2173
+ unit: LengthUnit;
2174
+ }
2175
+
2176
+ /**
2177
+ * Defines values for LengthUnit. \
2178
+ * {@link KnownLengthUnit} can be used interchangeably with LengthUnit,
2179
+ * this enum contains the known values that the service supports.
2180
+ * ### Known values supported by the service
2181
+ * **Unspecified** \
2182
+ * **Kilometer** \
2183
+ * **Hectometer** \
2184
+ * **Decameter** \
2185
+ * **Meter** \
2186
+ * **Decimeter** \
2187
+ * **Centimeter** \
2188
+ * **Millimeter** \
2189
+ * **Micrometer** \
2190
+ * **Nanometer** \
2191
+ * **Picometer** \
2192
+ * **Mile** \
2193
+ * **Yard** \
2194
+ * **Inch** \
2195
+ * **Foot** \
2196
+ * **LightYear** \
2197
+ * **Pt**
2198
+ */
2199
+ export declare type LengthUnit = string;
2200
+
1278
2201
  /** A word or phrase identified as a well-known entity within a database, including its formal (disambiguated) name and a link to the entity information within the source database. */
1279
2202
  export declare interface LinkedEntity {
1280
2203
  /** Entity Linking formal name. */
@@ -1305,6 +2228,42 @@ export declare interface Match {
1305
2228
  length: number;
1306
2229
  }
1307
2230
 
2231
+ /**
2232
+ * Defines values for NumberKind. \
2233
+ * {@link KnownNumberKind} can be used interchangeably with NumberKind,
2234
+ * this enum contains the known values that the service supports.
2235
+ * ### Known values supported by the service
2236
+ * **Integer** \
2237
+ * **Decimal** \
2238
+ * **Power** \
2239
+ * **Fraction** \
2240
+ * **Percent** \
2241
+ * **Unspecified**
2242
+ */
2243
+ export declare type NumberKind = string;
2244
+
2245
+ /** A resolution for numeric entity instances. */
2246
+ export declare interface NumberResolution extends BaseResolution {
2247
+ /** Polymorphic discriminator, which specifies the different types this object can be */
2248
+ resolutionKind: "NumberResolution";
2249
+ /** The type of the extracted number entity. */
2250
+ numberKind: NumberKind;
2251
+ /** A numeric representation of what the extracted text denotes. */
2252
+ value: string;
2253
+ }
2254
+
2255
+ /** represents the resolution of numeric intervals. */
2256
+ export declare interface NumericRangeResolution extends BaseResolution {
2257
+ /** Polymorphic discriminator, which specifies the different types this object can be */
2258
+ resolutionKind: "NumericRangeResolution";
2259
+ /** The kind of range that the resolution object represents. */
2260
+ rangeKind: RangeKind;
2261
+ /** The beginning value of the interval. */
2262
+ minimum: number;
2263
+ /** The ending value of the interval. */
2264
+ maximum: number;
2265
+ }
2266
+
1308
2267
  /**
1309
2268
  * A mined opinion object represents an opinion we've extracted from a sentence.
1310
2269
  * It consists of both a target that these assessments are about, and the actual
@@ -1321,6 +2280,18 @@ export declare interface Opinion {
1321
2280
  readonly assessments: AssessmentSentiment[];
1322
2281
  }
1323
2282
 
2283
+ /** A resolution for ordinal numbers entity instances. */
2284
+ export declare interface OrdinalResolution extends BaseResolution {
2285
+ /** Polymorphic discriminator, which specifies the different types this object can be */
2286
+ resolutionKind: "OrdinalResolution";
2287
+ /** The offset With respect to the reference (e.g., offset = -1 in "show me the second to last" */
2288
+ offset: string;
2289
+ /** The reference point that the ordinal number denotes. */
2290
+ relativeTo: RelativeTo;
2291
+ /** A simple arithmetic expression that the ordinal denotes. */
2292
+ value: string;
2293
+ }
2294
+
1324
2295
  /**
1325
2296
  * Paged results of the {@link TextAnalysisClient.beginAnalyzeBatch} operation.
1326
2297
  */
@@ -1584,6 +2555,30 @@ export declare interface PollerLike<TState extends OperationState<TResult>, TRes
1584
2555
  sendCancellationRequest: () => Promise<void>;
1585
2556
  }
1586
2557
 
2558
+ /** Represents resolutions for quantities. */
2559
+ export declare interface QuantityResolution {
2560
+ /** The numeric value that the extracted text denotes. */
2561
+ value: number;
2562
+ }
2563
+
2564
+ /**
2565
+ * Defines values for RangeKind. \
2566
+ * {@link KnownRangeKind} can be used interchangeably with RangeKind,
2567
+ * this enum contains the known values that the service supports.
2568
+ * ### Known values supported by the service
2569
+ * **Number** \
2570
+ * **Speed** \
2571
+ * **Weight** \
2572
+ * **Length** \
2573
+ * **Volume** \
2574
+ * **Area** \
2575
+ * **Age** \
2576
+ * **Information** \
2577
+ * **Temperature** \
2578
+ * **Currency**
2579
+ */
2580
+ export declare type RangeKind = string;
2581
+
1587
2582
  /**
1588
2583
  * Defines values for RelationType. \
1589
2584
  * {@link KnownRelationType} can be used interchangeably with RelationType,
@@ -1613,6 +2608,17 @@ export declare interface PollerLike<TState extends OperationState<TResult>, TRes
1613
2608
  */
1614
2609
  export declare type RelationType = string;
1615
2610
 
2611
+ /**
2612
+ * Defines values for RelativeTo. \
2613
+ * {@link KnownRelativeTo} can be used interchangeably with RelativeTo,
2614
+ * this enum contains the known values that the service supports.
2615
+ * ### Known values supported by the service
2616
+ * **Current** \
2617
+ * **End** \
2618
+ * **Start**
2619
+ */
2620
+ export declare type RelativeTo = string;
2621
+
1616
2622
  /**
1617
2623
  * Options for the begin analyze actions operation.
1618
2624
  */
@@ -1623,6 +2629,15 @@ export declare interface RestoreAnalyzeBatchPollerOptions extends TextAnalysisOp
1623
2629
  updateIntervalInMs?: number;
1624
2630
  }
1625
2631
 
2632
+ /**
2633
+ * Defines values for ScriptKind. \
2634
+ * {@link KnownScriptKind} can be used interchangeably with ScriptKind,
2635
+ * this enum contains the known values that the service supports.
2636
+ * ### Known values supported by the service
2637
+ * **Latin**
2638
+ */
2639
+ export declare type ScriptKind = string;
2640
+
1626
2641
  /**
1627
2642
  * The predicted sentiment for a given span of text. For more information
1628
2643
  * regarding text sentiment, see {@link https://docs.microsoft.com//azure/cognitive-services/language-service/sentiment-opinion-mining/overview}.
@@ -1730,6 +2745,36 @@ export declare interface SentimentConfidenceScores {
1730
2745
  negative: number;
1731
2746
  }
1732
2747
 
2748
+ /** Represents the speed entity resolution model. */
2749
+ export declare interface SpeedResolution extends BaseResolution, QuantityResolution {
2750
+ /** Polymorphic discriminator, which specifies the different types this object can be */
2751
+ resolutionKind: "SpeedResolution";
2752
+ /** The speed Unit of measurement */
2753
+ unit: SpeedUnit;
2754
+ }
2755
+
2756
+ /**
2757
+ * Defines values for SpeedUnit. \
2758
+ * {@link KnownSpeedUnit} can be used interchangeably with SpeedUnit,
2759
+ * this enum contains the known values that the service supports.
2760
+ * ### Known values supported by the service
2761
+ * **Unspecified** \
2762
+ * **MetersPerSecond** \
2763
+ * **KilometersPerHour** \
2764
+ * **KilometersPerMinute** \
2765
+ * **KilometersPerSecond** \
2766
+ * **MilesPerHour** \
2767
+ * **Knot** \
2768
+ * **FootPerSecond** \
2769
+ * **FootPerMinute** \
2770
+ * **YardsPerMinute** \
2771
+ * **YardsPerSecond** \
2772
+ * **MetersPerMillisecond** \
2773
+ * **CentimetersPerMillisecond** \
2774
+ * **KilometersPerMillisecond**
2775
+ */
2776
+ export declare type SpeedUnit = string;
2777
+
1733
2778
  /**
1734
2779
  * Defines values for StringIndexType. \
1735
2780
  * {@link KnownStringIndexType} can be used interchangeably with StringIndexType,
@@ -1741,6 +2786,26 @@ export declare interface SentimentConfidenceScores {
1741
2786
  */
1742
2787
  export declare type StringIndexType = string;
1743
2788
 
2789
+ /** The context of the summary. */
2790
+ export declare interface SummaryContext {
2791
+ /** Start position for the context. Use of different 'stringIndexType' values can affect the offset returned. */
2792
+ offset: number;
2793
+ /** The length of the context. Use of different 'stringIndexType' values can affect the length returned. */
2794
+ length: number;
2795
+ }
2796
+
2797
+ /** A sentence that is part of the extracted summary. */
2798
+ export declare interface SummarySentence {
2799
+ /** The extracted sentence text. */
2800
+ text: string;
2801
+ /** A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance. */
2802
+ rankScore: number;
2803
+ /** The sentence offset from the start of the document, based on the value of the parameter StringIndexType. */
2804
+ offset: number;
2805
+ /** The length of the sentence. */
2806
+ length: number;
2807
+ }
2808
+
1744
2809
  /** Represents the confidence scores across all sentiment classes: positive and negative. */
1745
2810
  export declare interface TargetConfidenceScores {
1746
2811
  /** Confidence score for positive sentiment */
@@ -1780,6 +2845,69 @@ export declare interface TargetSentiment {
1780
2845
  readonly length: number;
1781
2846
  }
1782
2847
 
2848
+ /** Represents the temperature entity resolution model. */
2849
+ export declare interface TemperatureResolution extends BaseResolution, QuantityResolution {
2850
+ /** Polymorphic discriminator, which specifies the different types this object can be */
2851
+ resolutionKind: "TemperatureResolution";
2852
+ /** The temperature Unit of measurement. */
2853
+ unit: TemperatureUnit;
2854
+ }
2855
+
2856
+ /**
2857
+ * Defines values for TemperatureUnit. \
2858
+ * {@link KnownTemperatureUnit} can be used interchangeably with TemperatureUnit,
2859
+ * this enum contains the known values that the service supports.
2860
+ * ### Known values supported by the service
2861
+ * **Unspecified** \
2862
+ * **Fahrenheit** \
2863
+ * **Kelvin** \
2864
+ * **Rankine** \
2865
+ * **Celsius**
2866
+ */
2867
+ export declare type TemperatureUnit = string;
2868
+
2869
+ /**
2870
+ * Defines values for TemporalModifier. \
2871
+ * {@link KnownTemporalModifier} can be used interchangeably with TemporalModifier,
2872
+ * this enum contains the known values that the service supports.
2873
+ * ### Known values supported by the service
2874
+ * **AfterApprox** \
2875
+ * **Before** \
2876
+ * **BeforeStart** \
2877
+ * **Approx** \
2878
+ * **ReferenceUndefined** \
2879
+ * **SinceEnd** \
2880
+ * **AfterMid** \
2881
+ * **Start** \
2882
+ * **After** \
2883
+ * **BeforeEnd** \
2884
+ * **Until** \
2885
+ * **End** \
2886
+ * **Less** \
2887
+ * **Since** \
2888
+ * **AfterStart** \
2889
+ * **BeforeApprox** \
2890
+ * **Mid** \
2891
+ * **More**
2892
+ */
2893
+ export declare type TemporalModifier = string;
2894
+
2895
+ /** represents the resolution of a date and/or time span. */
2896
+ export declare interface TemporalSpanResolution extends BaseResolution {
2897
+ /** Polymorphic discriminator, which specifies the different types this object can be */
2898
+ resolutionKind: "TemporalSpanResolution";
2899
+ /** An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) */
2900
+ begin?: string;
2901
+ /** An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) */
2902
+ end?: string;
2903
+ /** An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) */
2904
+ duration?: string;
2905
+ /** An optional modifier of a date/time instance. */
2906
+ modifier?: TemporalModifier;
2907
+ /** An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings. */
2908
+ timex?: string;
2909
+ }
2910
+
1783
2911
  /**
1784
2912
  * A client for interacting with the text analysis features in Azure Cognitive
1785
2913
  * Language Service.
@@ -2348,6 +3476,8 @@ export declare interface TextAnalysisSuccessResult {
2348
3476
 
2349
3477
  /** if includeStatistics=true was specified in the request this field will contain information about the request payload. */
2350
3478
  export declare interface TextDocumentBatchStatistics {
3479
+ /** Describes unknown properties. The value of an unknown property can be of "any" type. */
3480
+ [property: string]: any;
2351
3481
  /** Number of documents submitted in the request. */
2352
3482
  documentCount: number;
2353
3483
  /** Number of valid documents. This excludes empty, over-size limit or non-supported languages documents. */
@@ -2364,7 +3494,7 @@ export declare interface TextDocumentInput {
2364
3494
  id: string;
2365
3495
  /** The input text to process. */
2366
3496
  text: string;
2367
- /** (Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default. */
3497
+ /** (Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc. For Auto Language Detection, use "auto". If not set, use "en" for English as default. */
2368
3498
  language?: string;
2369
3499
  }
2370
3500
 
@@ -2379,6 +3509,50 @@ export declare interface TextDocumentStatistics {
2379
3509
  /** Defines values for TokenSentimentLabel. */
2380
3510
  export declare type TokenSentimentLabel = "positive" | "mixed" | "negative";
2381
3511
 
3512
+ /** Represents the volume entity resolution model. */
3513
+ export declare interface VolumeResolution extends BaseResolution, QuantityResolution {
3514
+ /** Polymorphic discriminator, which specifies the different types this object can be */
3515
+ resolutionKind: "VolumeResolution";
3516
+ /** The Volume Unit of measurement */
3517
+ unit: VolumeUnit;
3518
+ }
3519
+
3520
+ /**
3521
+ * Defines values for VolumeUnit. \
3522
+ * {@link KnownVolumeUnit} can be used interchangeably with VolumeUnit,
3523
+ * this enum contains the known values that the service supports.
3524
+ * ### Known values supported by the service
3525
+ * **Unspecified** \
3526
+ * **CubicMeter** \
3527
+ * **CubicCentimeter** \
3528
+ * **CubicMillimeter** \
3529
+ * **Hectoliter** \
3530
+ * **Decaliter** \
3531
+ * **Liter** \
3532
+ * **Centiliter** \
3533
+ * **Milliliter** \
3534
+ * **CubicYard** \
3535
+ * **CubicInch** \
3536
+ * **CubicFoot** \
3537
+ * **CubicMile** \
3538
+ * **FluidOunce** \
3539
+ * **Teaspoon** \
3540
+ * **Tablespoon** \
3541
+ * **Pint** \
3542
+ * **Quart** \
3543
+ * **Cup** \
3544
+ * **Gill** \
3545
+ * **Pinch** \
3546
+ * **FluidDram** \
3547
+ * **Barrel** \
3548
+ * **Minim** \
3549
+ * **Cord** \
3550
+ * **Peck** \
3551
+ * **Bushel** \
3552
+ * **Hogshead**
3553
+ */
3554
+ export declare type VolumeUnit = string;
3555
+
2382
3556
  /**
2383
3557
  * Defines values for WarningCode. \
2384
3558
  * {@link KnownWarningCode} can be used interchangeably with WarningCode,
@@ -2389,4 +3563,44 @@ export declare type TokenSentimentLabel = "positive" | "mixed" | "negative";
2389
3563
  */
2390
3564
  export declare type WarningCode = string;
2391
3565
 
3566
+ /** Represents the weight entity resolution model. */
3567
+ export declare interface WeightResolution extends BaseResolution, QuantityResolution {
3568
+ /** Polymorphic discriminator, which specifies the different types this object can be */
3569
+ resolutionKind: "WeightResolution";
3570
+ /** The weight Unit of measurement. */
3571
+ unit: WeightUnit;
3572
+ }
3573
+
3574
+ /**
3575
+ * Defines values for WeightUnit. \
3576
+ * {@link KnownWeightUnit} can be used interchangeably with WeightUnit,
3577
+ * this enum contains the known values that the service supports.
3578
+ * ### Known values supported by the service
3579
+ * **Unspecified** \
3580
+ * **Kilogram** \
3581
+ * **Gram** \
3582
+ * **Milligram** \
3583
+ * **Gallon** \
3584
+ * **MetricTon** \
3585
+ * **Ton** \
3586
+ * **Pound** \
3587
+ * **Ounce** \
3588
+ * **Grain** \
3589
+ * **PennyWeight** \
3590
+ * **LongTonBritish** \
3591
+ * **ShortTonUS** \
3592
+ * **ShortHundredWeightUS** \
3593
+ * **Stone** \
3594
+ * **Dram**
3595
+ */
3596
+ export declare type WeightUnit = string;
3597
+
3598
+ /**
3599
+ * Document results with potentially automatically detected language.
3600
+ */
3601
+ export declare type WithDetectedLanguage<T> = T & DocumentDetectedLanguage & {
3602
+ /** Indicates whether the default language hint was used */
3603
+ isLanguageDefaulted?: boolean;
3604
+ };
3605
+
2392
3606
  export { }