File: _enums.py

package info (click to toggle)
python-azure 20251104%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 770,224 kB
  • sloc: python: 6,357,217; ansic: 804; javascript: 287; makefile: 198; sh: 193; xml: 109
file content (790 lines) | stat: -rw-r--r-- 26,209 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) Python Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------

from enum import Enum
from azure.core import CaseInsensitiveEnumMeta


class AgeUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The Age Unit of measurement."""

    UNSPECIFIED = "Unspecified"
    """Unspecified age unit"""
    YEAR = "Year"
    """Year age unit"""
    MONTH = "Month"
    """Month age unit"""
    WEEK = "Week"
    """Week age unit"""
    DAY = "Day"
    """Day age unit"""


class AnalyzeConversationInputKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Enumeration of supported Conversation tasks."""

    CONVERSATION = "Conversation"
    """Conversation task kind"""
    CONVERSATIONAL_AI = "ConversationalAI"
    """Conversation task kind"""


class AnalyzeConversationOperationActionKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Enumeration of supported analysis tasks on a collection of conversations."""

    CONVERSATIONAL_SUMMARIZATION_TASK = "ConversationalSummarizationTask"
    """Conversational Summarization Task"""
    CONVERSATIONAL_PII_TASK = "ConversationalPIITask"
    """Conversational PII Task"""
    CUSTOM_CONVERSATIONAL_SUMMARIZATION_TASK = "CustomConversationalSummarizationTask"
    """Custom Conversational Summarization Task"""


class AnalyzeConversationOperationResultsKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Enumeration of results for supported conversation analysis Results."""

    SUMMARIZATION_OPERATION_RESULTS = "conversationalSummarizationResults"
    """Conversational Summarization Results"""
    PII_OPERATION_RESULTS = "conversationalPIIResults"
    """Conversational PII Results"""
    CUSTOM_SUMMARIZATION_OPERATION_RESULTS = "customConversationalSummarizationResults"
    """Custom Conversational Summarization Results"""


class AnalyzeConversationResultKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Enumeration of supported conversational task results."""

    CONVERSATION_RESULT = "ConversationResult"
    """Conversation result task kind"""
    CONVERSATIONAL_AI_RESULT = "ConversationalAIResult"
    """Conversation result task kind"""


class AreaUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The area unit of measurement."""

    UNSPECIFIED = "Unspecified"
    """Unspecified area unit"""
    SQUARE_KILOMETER = "SquareKilometer"
    """Square kilometer area unit"""
    SQUARE_HECTOMETER = "SquareHectometer"
    """Square hectometer area unit"""
    SQUARE_DECAMETER = "SquareDecameter"
    """Square decameter area unit"""
    SQUARE_DECIMETER = "SquareDecimeter"
    """Square decimeter area unit"""
    SQUARE_METER = "SquareMeter"
    """Square meter area unit"""
    SQUARE_CENTIMETER = "SquareCentimeter"
    """Square centimeter area unit"""
    SQUARE_MILLIMETER = "SquareMillimeter"
    """Square millimeter area unit"""
    SQUARE_INCH = "SquareInch"
    """Square inch area unit"""
    SQUARE_FOOT = "SquareFoot"
    """Square foot area unit"""
    SQUARE_MILE = "SquareMile"
    """Square mile area unit"""
    SQUARE_YARD = "SquareYard"
    """Square yard area unit"""
    ACRE = "Acre"
    """Acre area unit"""


class ConversationActionState(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The status of the task at the mentioned last update time."""

    NOT_STARTED = "notStarted"
    """Not started state"""
    RUNNING = "running"
    """Running state"""
    SUCCEEDED = "succeeded"
    """Succeeded state"""
    PARTIALLY_COMPLETED = "partiallyCompleted"
    """Partially completed state"""
    FAILED = "failed"
    """Failed state"""
    CANCELLED = "cancelled"
    """Cancelled state"""
    CANCELLING = "cancelling"
    """Cancelling state"""


class ConversationDomain(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Enumeration of supported conversational domains."""

    FINANCE = "finance"
    """Enumeration of supported conversational domains."""
    HEALTHCARE = "healthcare"
    """Enumeration of supported conversational domains."""
    GENERIC = "generic"
    """Enumeration of supported conversational domains."""


class ConversationErrorCode(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Human-readable error code."""

    INVALID_REQUEST = "InvalidRequest"
    """Invalid request error"""
    INVALID_ARGUMENT = "InvalidArgument"
    """Invalid argument error"""
    UNAUTHORIZED = "Unauthorized"
    """Unauthorized access error"""
    FORBIDDEN = "Forbidden"
    """Forbidden access error"""
    NOT_FOUND = "NotFound"
    """Not found error"""
    PROJECT_NOT_FOUND = "ProjectNotFound"
    """Project not found error"""
    OPERATION_NOT_FOUND = "OperationNotFound"
    """Operation not found error"""
    AZURE_COGNITIVE_SEARCH_NOT_FOUND = "AzureCognitiveSearchNotFound"
    """Azure Cognitive Search not found error"""
    AZURE_COGNITIVE_SEARCH_INDEX_NOT_FOUND = "AzureCognitiveSearchIndexNotFound"
    """Azure Cognitive Search index not found error"""
    TOO_MANY_REQUESTS = "TooManyRequests"
    """Too many requests error"""
    AZURE_COGNITIVE_SEARCH_THROTTLING = "AzureCognitiveSearchThrottling"
    """Azure Cognitive Search throttling error"""
    AZURE_COGNITIVE_SEARCH_INDEX_LIMIT_REACHED = "AzureCognitiveSearchIndexLimitReached"
    """Azure Cognitive Search index limit reached error"""
    INTERNAL_SERVER_ERROR = "InternalServerError"
    """Internal server error"""
    SERVICE_UNAVAILABLE = "ServiceUnavailable"
    """Service unavailable error"""
    TIMEOUT = "Timeout"
    """Timeout error"""
    QUOTA_EXCEEDED = "QuotaExceeded"
    """Quota exceeded error"""
    CONFLICT = "Conflict"
    """Conflict error"""
    WARNING = "Warning"
    """Warning error"""


class ConversationPiiCategories(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Describes the PII categories to return for detection. If not provided, 'default' categories
    will be returned which will vary with the language.
    """

    ADDRESS = "Address"
    """Address category"""
    CREDIT_CARD = "CreditCard"
    """Credit card category"""
    EMAIL = "Email"
    """Email category"""
    PERSON = "Person"
    """Person category"""
    NUMERIC_IDENTIFIER = "NumericIdentifier"
    """Numeric identifier category"""
    PHONE = "Phone"
    """Phone category"""
    US_SOCIAL_SECURITY_NUMBER = "USSocialSecurityNumber"
    """US social security number category"""
    ALL = "All"
    """All categories"""
    DEFAULT = "Default"
    """Default categories"""


class ConversationPiiCategoryExclusions(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Describes the PII categories to exclude for detection. If not provided, 'default' categories
    will be returned which will vary with the language.
    """

    ADDRESS = "Address"
    """Address category"""
    CREDIT_CARD = "CreditCard"
    """Credit card category"""
    EMAIL = "Email"
    """Email category"""
    PERSON = "Person"
    """Person category"""
    NUMERIC_IDENTIFIER = "NumericIdentifier"
    """Numeric identifier category"""
    PHONE = "Phone"
    """Phone category"""
    US_SOCIAL_SECURITY_NUMBER = "USSocialSecurityNumber"
    """US social security number category"""


class DateTimeSubKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The Datetime SubKind."""

    TIME = "Time"
    """Time subkind"""
    DATE = "Date"
    """Date subkind"""
    DATE_TIME = "DateTime"
    """DateTime subkind"""
    DURATION = "Duration"
    """Duration subkind"""
    SET = "Set"
    """Set subkind"""


class ExtraInformationKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The extra information object kind."""

    ENTITY_SUBTYPE = "EntitySubtype"
    """Entity subtype extra information kind"""
    LIST_KEY = "ListKey"
    """List key extra information kind"""
    REGEX_KEY = "RegexKey"
    """Regex key extra information kind"""


class InformationUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The information (data) Unit of measurement."""

    UNSPECIFIED = "Unspecified"
    """Unspecified information unit"""
    BIT = "Bit"
    """Bit information unit"""
    KILOBIT = "Kilobit"
    """Kilobit information unit"""
    MEGABIT = "Megabit"
    """Megabit information unit"""
    GIGABIT = "Gigabit"
    """Gigabit information unit"""
    TERABIT = "Terabit"
    """Terabit information unit"""
    PETABIT = "Petabit"
    """Petabit information unit"""
    BYTE = "Byte"
    """Byte information unit"""
    KILOBYTE = "Kilobyte"
    """Kilobyte information unit"""
    MEGABYTE = "Megabyte"
    """Megabyte information unit"""
    GIGABYTE = "Gigabyte"
    """Gigabyte information unit"""
    TERABYTE = "Terabyte"
    """Terabyte information unit"""
    PETABYTE = "Petabyte"
    """Petabyte information unit"""


class InnerErrorCode(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Human-readable error code."""

    INVALID_REQUEST = "InvalidRequest"
    """Invalid request error"""
    INVALID_PARAMETER_VALUE = "InvalidParameterValue"
    """Invalid parameter value error"""
    KNOWLEDGE_BASE_NOT_FOUND = "KnowledgeBaseNotFound"
    """Knowledge base not found error"""
    AZURE_COGNITIVE_SEARCH_NOT_FOUND = "AzureCognitiveSearchNotFound"
    """Azure Cognitive Search not found error"""
    AZURE_COGNITIVE_SEARCH_THROTTLING = "AzureCognitiveSearchThrottling"
    """Azure Cognitive Search throttling error"""
    EXTRACTION_FAILURE = "ExtractionFailure"
    """Extraction failure error"""
    INVALID_REQUEST_BODY_FORMAT = "InvalidRequestBodyFormat"
    """Invalid request body format error"""
    EMPTY_REQUEST = "EmptyRequest"
    """Empty request error"""
    MISSING_INPUT_DOCUMENTS = "MissingInputDocuments"
    """Missing input documents error"""
    INVALID_DOCUMENT = "InvalidDocument"
    """Invalid document error"""
    MODEL_VERSION_INCORRECT = "ModelVersionIncorrect"
    """Model version incorrect error"""
    INVALID_DOCUMENT_BATCH = "InvalidDocumentBatch"
    """Invalid document batch error"""
    UNSUPPORTED_LANGUAGE_CODE = "UnsupportedLanguageCode"
    """Unsupported language code error"""
    INVALID_COUNTRY_HINT = "InvalidCountryHint"
    """Invalid country hint error"""


class InputModality(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Enumeration of supported conversational modalities."""

    TRANSCRIPT = "transcript"
    """Transcript input modality"""
    TEXT = "text"
    """Text input modality"""


class LengthUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The length unit of measurement."""

    UNSPECIFIED = "Unspecified"
    """Unspecified length unit"""
    KILOMETER = "Kilometer"
    """Kilometer length unit"""
    HECTOMETER = "Hectometer"
    """Hectometer length unit"""
    DECAMETER = "Decameter"
    """Decameter length unit"""
    METER = "Meter"
    """Meter length unit"""
    DECIMETER = "Decimeter"
    """Decimeter length unit"""
    CENTIMETER = "Centimeter"
    """Centimeter length unit"""
    MILLIMETER = "Millimeter"
    """Millimeter length unit"""
    MICROMETER = "Micrometer"
    """Micrometer length unit"""
    NANOMETER = "Nanometer"
    """Nanometer length unit"""
    PICOMETER = "Picometer"
    """Picometer length unit"""
    MILE = "Mile"
    """Mile length unit"""
    YARD = "Yard"
    """Yard length unit"""
    INCH = "Inch"
    """Inch length unit"""
    FOOT = "Foot"
    """Foot length unit"""
    LIGHT_YEAR = "LightYear"
    """Light year length unit"""
    POINT = "Pt"
    """Point length unit"""


class LogicalOperationKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Set to 'OR' or 'AND' for using corresponding logical operation."""

    AND = "AND"
    """Logical AND"""
    OR = "OR"
    """Logical OR"""


class NumberKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The type of the extracted number entity."""

    INTEGER = "Integer"
    """Integer number"""
    DECIMAL = "Decimal"
    """Decimal number"""
    POWER = "Power"
    """Power number"""
    FRACTION = "Fraction"
    """Fraction number"""
    PERCENT = "Percent"
    """Percent number"""
    UNSPECIFIED = "Unspecified"
    """Unspecified number kind"""


class ParticipantRole(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Role of the participant."""

    CUSTOMER = "customer"
    """The participant is a customer."""
    AGENT = "agent"
    """The participant is an agent."""
    GENERIC = "generic"
    """The is a generic participant."""


class ProjectKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The type of the project."""

    CONVERSATION = "Conversation"
    """Conversation type"""
    ORCHESTRATION = "Orchestration"
    """Orchestration type"""
    CONVERSATIONAL_AI = "ConversationalAI"
    """Conversation type"""


class RangeKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The kind of range that the resolution object represents."""

    NUMBER = "Number"
    """Number range"""
    SPEED = "Speed"
    """Speed range"""
    WEIGHT = "Weight"
    """Weight range"""
    LENGTH = "Length"
    """Length range"""
    VOLUME = "Volume"
    """Volume range"""
    AREA = "Area"
    """Area range"""
    AGE = "Age"
    """Age range"""
    INFORMATION = "Information"
    """Information range"""
    TEMPERATURE = "Temperature"
    """Temperature range"""
    CURRENCY = "Currency"
    """Currency range"""


class RankerKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Type of ranker to be used."""

    DEFAULT = "Default"
    """Default ranker."""
    QUESTION_ONLY = "QuestionOnly"
    """Question only ranker."""


class RedactionCharacter(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Optional parameter to use a Custom Character to be used for redaction in PII responses. Default
    character will be * as before. We allow specific ascii characters for redaction.
    """

    EXCLAMATION_POINT = "!"
    """Exclamation point character"""
    NUMBER_SIGN = "#"
    """Number sign character"""
    DOLLAR = "$"
    """Dollar sign character"""
    PERCENT = "%"
    """Percent sign character"""
    AMPERSAND = "&"
    """Ampersand character"""
    ASTERISK = "*"
    """Asterisk character"""
    PLUS = "+"
    """Plus sign character"""
    MINUS = "-"
    """Minus sign character"""
    EQUALS = "="
    """Equals sign character"""
    QUESTION_MARK = "?"
    """Question mark character"""
    AT_SIGN = "@"
    """At sign character"""
    CARET = "^"
    """Caret character"""
    UNDERSCORE = "_"
    """Underscore character"""
    TILDE = "~"
    """Tilde character"""


class RedactionPolicyKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Kinds of redaction policies supported."""

    NO_MASK = "noMask"
    """Do not mask detected entities"""
    CHARACTER_MASK = "characterMask"
    """Mask detected entities with redaction character"""
    ENTITY_MASK = "entityMask"
    """Mask detected entities with entity type"""


class RelativeTo(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The reference point that the ordinal number denotes."""

    CURRENT = "Current"
    """Current state"""
    END = "End"
    """End state"""
    START = "Start"
    """Start state"""


class ResolutionKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The entity resolution object kind."""

    BOOLEAN_RESOLUTION = "BooleanResolution"
    """Resolution of a boolean entity"""
    DATE_TIME_RESOLUTION = "DateTimeResolution"
    """Resolution of a date/time entity"""
    NUMBER_RESOLUTION = "NumberResolution"
    """Resolution of a number entity"""
    ORDINAL_RESOLUTION = "OrdinalResolution"
    """Resolution of an ordinal entity"""
    SPEED_RESOLUTION = "SpeedResolution"
    """Resolution of a speed entity"""
    WEIGHT_RESOLUTION = "WeightResolution"
    """Resolution of a weight entity"""
    LENGTH_RESOLUTION = "LengthResolution"
    """Resolution of a length entity"""
    VOLUME_RESOLUTION = "VolumeResolution"
    """Resolution of a volume entity"""
    AREA_RESOLUTION = "AreaResolution"
    """Resolution of an area entity"""
    AGE_RESOLUTION = "AgeResolution"
    """Resolution of an age entity"""
    INFORMATION_RESOLUTION = "InformationResolution"
    """Resolution of an information entity"""
    TEMPERATURE_RESOLUTION = "TemperatureResolution"
    """Resolution of a temperature entity"""
    CURRENCY_RESOLUTION = "CurrencyResolution"
    """Resolution of a currency entity"""
    NUMERIC_RANGE_RESOLUTION = "NumericRangeResolution"
    """Resolution of a numeric range entity"""
    TEMPORAL_SPAN_RESOLUTION = "TemporalSpanResolution"
    """Resolution of a temporal span entity"""


class SpeedUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The speed Unit of measurement."""

    UNSPECIFIED = "Unspecified"
    """Unspecified speed unit"""
    METERS_PER_SECOND = "MetersPerSecond"
    """Meters per second speed unit"""
    KILOMETERS_PER_HOUR = "KilometersPerHour"
    """Kilometers per hour speed unit"""
    KILOMETERS_PER_MINUTE = "KilometersPerMinute"
    """Kilometers per minute speed unit"""
    KILOMETERS_PER_SECOND = "KilometersPerSecond"
    """Kilometers per second speed unit"""
    MILES_PER_HOUR = "MilesPerHour"
    """Miles per hour speed unit"""
    KNOT = "Knot"
    """Knot speed unit"""
    FOOT_PER_SECOND = "FootPerSecond"
    """Foot per second speed unit"""
    FOOT_PER_MINUTE = "FootPerMinute"
    """Foot per minute speed unit"""
    YARDS_PER_MINUTE = "YardsPerMinute"
    """Yards per minute speed unit"""
    YARDS_PER_SECOND = "YardsPerSecond"
    """Yards per second speed unit"""
    METERS_PER_MILLISECOND = "MetersPerMillisecond"
    """Meters per millisecond speed unit"""
    CENTIMETERS_PER_MILLISECOND = "CentimetersPerMillisecond"
    """Centimeters per millisecond speed unit"""
    KILOMETERS_PER_MILLISECOND = "KilometersPerMillisecond"
    """Kilometers per millisecond speed unit"""


class StringIndexType(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Specifies the method used to interpret string offsets.  Defaults to Text Elements (Graphemes)
    according to Unicode v8.0.0. For additional information see
    `https://aka.ms/text-analytics-offsets <https://aka.ms/text-analytics-offsets>`_.
    """

    TEXT_ELEMENTS_V8 = "TextElements_v8"
    """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."""
    UNICODE_CODE_POINT = "UnicodeCodePoint"
    """Returned offset and length values will correspond to Unicode code points. Use this option if
    your application is written in a language that support Unicode, for example Python."""
    UTF16_CODE_UNIT = "Utf16CodeUnit"
    """Returned offset and length values will correspond to UTF-16 code units. Use this option if your
    application is written in a language that support Unicode, for example Java, JavaScript."""


class SummaryAspect(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Supported parameters for a conversational summarization task."""

    ISSUE = "issue"
    """Summary of issues in transcripts of web chats and service calls between customer-service agents
    and customers."""
    RESOLUTION = "resolution"
    """Summary of resolutions in transcripts of web chats and service calls between customer-service
    agents and customers."""
    CHAPTER_TITLE = "chapterTitle"
    """Chapter title of any conversation. It's usually one phrase or several phrases naturally
    combined. Long conversations tend to have more chapters. You can find the chapter boundary from
    the summary context."""
    NARRATIVE = "narrative"
    """Generic narrative summary of any conversation. It generally converts the conversational
    language into formal written language, compresses the text length, and keeps the salient
    information."""
    RECAP = "recap"
    """A concise one-paragraph summary to provide a quick overview."""
    FOLLOW_UP_TASKS = "follow-up tasks"
    """Action items and tasks that arose during a meeting."""


class SummaryLengthBucket(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Enum that defines the length of the output summaries."""

    SHORT = "short"
    """Instructs model to generate shorter length summaries."""
    MEDIUM = "medium"
    """Instructs model to generate medium length summaries."""
    LONG = "long"
    """Instructs model to generate longer length summaries."""


class TargetProjectKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The type of a target service."""

    LUIS = "Luis"
    """Luis target service type"""
    CONVERSATION = "Conversation"
    """Conversation target service type"""
    QUESTION_ANSWERING = "QuestionAnswering"
    """QuestionAnswering target service type"""
    NON_LINKED = "NonLinked"
    """NonLinked target service type"""


class TemperatureUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The temperature Unit of measurement."""

    UNSPECIFIED = "Unspecified"
    """Unspecified temperature unit"""
    FAHRENHEIT = "Fahrenheit"
    """Fahrenheit temperature unit"""
    KELVIN = "Kelvin"
    """Kelvin temperature unit"""
    RANKINE = "Rankine"
    """Rankine temperature unit"""
    CELSIUS = "Celsius"
    """Celsius temperature unit"""


class TemporalModifier(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """An optional modifier of a date/time instance."""

    AFTER_APPROXIMATE = "AfterApprox"
    """AfterApprox temporal modifier"""
    BEFORE = "Before"
    """Before temporal modifier"""
    BEFORE_START = "BeforeStart"
    """BeforeStart temporal modifier"""
    APPROXIMATE = "Approx"
    """Approx temporal modifier"""
    REFERENCE_UNDEFINED = "ReferenceUndefined"
    """ReferenceUndefined temporal modifier"""
    SINCE_END = "SinceEnd"
    """SinceEnd temporal modifier"""
    AFTER_MID = "AfterMid"
    """AfterMid temporal modifier"""
    START = "Start"
    """Start temporal modifier"""
    AFTER = "After"
    """After temporal modifier"""
    BEFORE_END = "BeforeEnd"
    """BeforeEnd temporal modifier"""
    UNTIL = "Until"
    """Until temporal modifier"""
    END = "End"
    """End temporal modifier"""
    LESS = "Less"
    """Less temporal modifier"""
    SINCE = "Since"
    """Since temporal modifier"""
    AFTER_START = "AfterStart"
    """AfterStart temporal modifier"""
    BEFORE_APPROXIMATE = "BeforeApprox"
    """BeforeApprox temporal modifier"""
    MID = "Mid"
    """Mid temporal modifier"""
    MORE = "More"
    """More temporal modifier"""


class TranscriptContentType(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """Enumeration of supported transcript content types."""

    LEXICAL = "lexical"
    """Lexical content type"""
    ITN = "itn"
    """ITN content type"""
    MASKED_ITN = "maskedItn"
    """Masked ITN content type"""
    TEXT = "text"
    """Text content type"""


class VolumeUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The Volume Unit of measurement."""

    UNSPECIFIED = "Unspecified"
    """Unspecified volume unit."""
    CUBIC_METER = "CubicMeter"
    """Volume unit in cubic meters."""
    CUBIC_CENTIMETER = "CubicCentimeter"
    """Volume unit in cubic centimeters."""
    CUBIC_MILLIMETER = "CubicMillimeter"
    """Volume unit in cubic millimeters."""
    HECTOLITER = "Hectoliter"
    """Volume unit in hectoliters."""
    DECALITER = "Decaliter"
    """Volume unit in decaliters."""
    LITER = "Liter"
    """Volume unit in liters."""
    CENTILITER = "Centiliter"
    """Volume unit in centiliters."""
    MILLILITER = "Milliliter"
    """Volume unit in milliliters."""
    CUBIC_YARD = "CubicYard"
    """Volume unit in cubic yards."""
    CUBIC_INCH = "CubicInch"
    """Volume unit in cubic inches."""
    CUBIC_FOOT = "CubicFoot"
    """Volume unit in cubic feet."""
    CUBIC_MILE = "CubicMile"
    """Volume unit in cubic miles."""
    FLUID_OUNCE = "FluidOunce"
    """Volume unit in fluid ounces."""
    TEASPOON = "Teaspoon"
    """Volume unit in teaspoons."""
    TABLESPOON = "Tablespoon"
    """Volume unit in tablespoons."""
    PINT = "Pint"
    """Volume unit in pints."""
    QUART = "Quart"
    """Volume unit in quarts."""
    CUP = "Cup"
    """Volume unit in cups."""
    GILL = "Gill"
    """Volume unit in gills."""
    PINCH = "Pinch"
    """Volume unit in pinches."""
    FLUID_DRAM = "FluidDram"
    """Volume unit in fluid drams."""
    BARREL = "Barrel"
    """Volume unit in barrels."""
    MINIM = "Minim"
    """Volume unit in minims."""
    CORD = "Cord"
    """Volume unit in cords."""
    PECK = "Peck"
    """Volume unit in pecks."""
    BUSHEL = "Bushel"
    """Volume unit in bushels."""
    HOGSHEAD = "Hogshead"
    """Volume unit in hogsheads."""


class WeightUnit(str, Enum, metaclass=CaseInsensitiveEnumMeta):
    """The weight Unit of measurement."""

    UNSPECIFIED = "Unspecified"
    """Unspecified weight unit"""
    KILOGRAM = "Kilogram"
    """Weight unit in kilograms"""
    GRAM = "Gram"
    """Weight unit in grams"""
    MILLIGRAM = "Milligram"
    """Weight unit in milligrams"""
    GALLON = "Gallon"
    """Volume unit in gallons"""
    METRIC_TON = "MetricTon"
    """Weight unit in metric tons"""
    TON = "Ton"
    """Weight unit in tons"""
    POUND = "Pound"
    """Weight unit in pounds"""
    OUNCE = "Ounce"
    """Weight unit in ounces"""
    GRAIN = "Grain"
    """Weight unit in grains"""
    PENNY_WEIGHT = "PennyWeight"
    """Weight unit in pennyweights"""
    LONG_TON_BRITISH = "LongTonBritish"
    """Weight unit in long tons (British)"""
    SHORT_TON_US = "ShortTonUS"
    """Weight unit in short tons (US)"""
    SHORT_HUNDRED_WEIGHT_US = "ShortHundredWeightUS"
    """Weight unit in short hundredweights (US)"""
    STONE = "Stone"
    """Weight unit in stones"""
    DRAM = "Dram"
    """Weight unit in drams"""