@azure/ai-language-text 1.0.1-alpha.20221014.1 → 1.1.0-alpha.20221101.3

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