@azure/ai-language-conversations 1.0.0-beta.1 → 1.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (246) hide show
  1. package/LICENSE +4 -4
  2. package/README.md +15 -11
  3. package/{types/src → dist/browser}/azureKeyCredentialPolicy.d.ts +2 -2
  4. package/dist/browser/azureKeyCredentialPolicy.d.ts.map +1 -0
  5. package/{dist-esm/src → dist/browser}/azureKeyCredentialPolicy.js +1 -1
  6. package/dist/browser/azureKeyCredentialPolicy.js.map +1 -0
  7. package/{dist-esm/src → dist/browser}/constants.js +1 -1
  8. package/{dist-esm/src → dist/browser}/constants.js.map +1 -1
  9. package/{types/src → dist/browser}/conversationAnalysisClient.d.ts +6 -8
  10. package/dist/browser/conversationAnalysisClient.d.ts.map +1 -0
  11. package/{dist-esm/src → dist/browser}/conversationAnalysisClient.js +8 -10
  12. package/dist/browser/conversationAnalysisClient.js.map +1 -0
  13. package/{types/src → dist/browser}/generated/conversationAnalysisClient.d.ts +1 -1
  14. package/dist/browser/generated/conversationAnalysisClient.d.ts.map +1 -0
  15. package/{dist-esm/src → dist/browser}/generated/conversationAnalysisClient.js +25 -14
  16. package/{dist-esm/src → dist/browser}/generated/conversationAnalysisClient.js.map +1 -1
  17. package/dist/browser/generated/index.d.ts +3 -0
  18. package/{types/src → dist/browser}/generated/index.d.ts.map +1 -1
  19. package/{dist-esm/src → dist/browser}/generated/index.js +2 -2
  20. package/dist/browser/generated/index.js.map +1 -0
  21. package/{dist-esm/src → dist/browser}/generated/lroImpl.js +11 -3
  22. package/dist/browser/generated/lroImpl.js.map +1 -0
  23. package/{types/src → dist/browser}/generated/models/index.d.ts +46 -46
  24. package/dist/browser/generated/models/index.d.ts.map +1 -0
  25. package/{dist-esm/src → dist/browser}/generated/models/mappers.js +297 -117
  26. package/dist/browser/generated/models/mappers.js.map +1 -0
  27. package/{dist-esm/src → dist/browser}/generated/models/parameters.js +1 -1
  28. package/{dist-esm/src → dist/browser}/generated/models/parameters.js.map +1 -1
  29. package/{types/src → dist/browser}/index.d.ts +3 -3
  30. package/{types/src → dist/browser}/index.d.ts.map +1 -1
  31. package/{dist-esm/src → dist/browser}/index.js +4 -4
  32. package/dist/browser/index.js.map +1 -0
  33. package/{types/src → dist/browser}/models.d.ts +47 -47
  34. package/dist/browser/models.d.ts.map +1 -0
  35. package/{dist-esm/src → dist/browser}/models.js +0 -2
  36. package/dist/browser/models.js.map +1 -0
  37. package/dist/browser/package.json +3 -0
  38. package/dist/commonjs/azureKeyCredentialPolicy.d.ts +9 -0
  39. package/dist/commonjs/azureKeyCredentialPolicy.d.ts.map +1 -0
  40. package/dist/commonjs/azureKeyCredentialPolicy.js +25 -0
  41. package/dist/commonjs/azureKeyCredentialPolicy.js.map +1 -0
  42. package/dist/commonjs/constants.d.ts +3 -0
  43. package/dist/commonjs/constants.d.ts.map +1 -0
  44. package/dist/commonjs/constants.js +8 -0
  45. package/dist/commonjs/constants.js.map +1 -0
  46. package/dist/commonjs/conversationAnalysisClient.d.ts +63 -0
  47. package/dist/commonjs/conversationAnalysisClient.d.ts.map +1 -0
  48. package/dist/commonjs/conversationAnalysisClient.js +85 -0
  49. package/dist/commonjs/conversationAnalysisClient.js.map +1 -0
  50. package/dist/commonjs/generated/conversationAnalysisClient.d.ts +36 -0
  51. package/dist/commonjs/generated/conversationAnalysisClient.d.ts.map +1 -0
  52. package/dist/commonjs/generated/conversationAnalysisClient.js +207 -0
  53. package/dist/commonjs/generated/conversationAnalysisClient.js.map +1 -0
  54. package/dist/commonjs/generated/index.d.ts +3 -0
  55. package/dist/commonjs/generated/index.d.ts.map +1 -0
  56. package/dist/commonjs/generated/index.js +15 -0
  57. package/dist/commonjs/generated/index.js.map +1 -0
  58. package/dist/commonjs/generated/lroImpl.d.ts +16 -0
  59. package/dist/commonjs/generated/lroImpl.d.ts.map +1 -0
  60. package/dist/commonjs/generated/lroImpl.js +37 -0
  61. package/dist/commonjs/generated/lroImpl.js.map +1 -0
  62. package/dist/commonjs/generated/models/index.d.ts +1951 -0
  63. package/dist/commonjs/generated/models/index.d.ts.map +1 -0
  64. package/dist/commonjs/generated/models/index.js +659 -0
  65. package/dist/commonjs/generated/models/index.js.map +1 -0
  66. package/dist/commonjs/generated/models/mappers.d.ts +153 -0
  67. package/dist/commonjs/generated/models/mappers.d.ts.map +1 -0
  68. package/dist/commonjs/generated/models/mappers.js +2847 -0
  69. package/dist/commonjs/generated/models/mappers.js.map +1 -0
  70. package/dist/commonjs/generated/models/parameters.d.ts +8 -0
  71. package/dist/commonjs/generated/models/parameters.d.ts.map +1 -0
  72. package/dist/commonjs/generated/models/parameters.js +64 -0
  73. package/dist/commonjs/generated/models/parameters.js.map +1 -0
  74. package/dist/commonjs/index.d.ts +13 -0
  75. package/dist/commonjs/index.d.ts.map +1 -0
  76. package/dist/commonjs/index.js +21 -0
  77. package/dist/commonjs/index.js.map +1 -0
  78. package/{types/ai-language-conversations.d.ts → dist/commonjs/models.d.ts} +1953 -2221
  79. package/dist/commonjs/models.d.ts.map +1 -0
  80. package/dist/commonjs/models.js +652 -0
  81. package/dist/commonjs/models.js.map +1 -0
  82. package/dist/commonjs/package.json +3 -0
  83. package/{types → dist/commonjs}/tsdoc-metadata.json +11 -11
  84. package/dist/esm/azureKeyCredentialPolicy.d.ts +9 -0
  85. package/dist/esm/azureKeyCredentialPolicy.d.ts.map +1 -0
  86. package/dist/esm/azureKeyCredentialPolicy.js +22 -0
  87. package/dist/esm/azureKeyCredentialPolicy.js.map +1 -0
  88. package/dist/esm/constants.d.ts +3 -0
  89. package/dist/esm/constants.d.ts.map +1 -0
  90. package/dist/esm/constants.js +5 -0
  91. package/dist/esm/constants.js.map +1 -0
  92. package/dist/esm/conversationAnalysisClient.d.ts +63 -0
  93. package/dist/esm/conversationAnalysisClient.d.ts.map +1 -0
  94. package/dist/esm/conversationAnalysisClient.js +81 -0
  95. package/dist/esm/conversationAnalysisClient.js.map +1 -0
  96. package/dist/esm/generated/conversationAnalysisClient.d.ts +36 -0
  97. package/dist/esm/generated/conversationAnalysisClient.d.ts.map +1 -0
  98. package/dist/esm/generated/conversationAnalysisClient.js +202 -0
  99. package/dist/esm/generated/conversationAnalysisClient.js.map +1 -0
  100. package/dist/esm/generated/index.d.ts +3 -0
  101. package/dist/esm/generated/index.d.ts.map +1 -0
  102. package/dist/esm/generated/index.js +10 -0
  103. package/dist/esm/generated/index.js.map +1 -0
  104. package/dist/esm/generated/lroImpl.d.ts +16 -0
  105. package/dist/esm/generated/lroImpl.d.ts.map +1 -0
  106. package/dist/esm/generated/lroImpl.js +33 -0
  107. package/dist/esm/generated/lroImpl.js.map +1 -0
  108. package/dist/esm/generated/models/index.d.ts +1951 -0
  109. package/dist/esm/generated/models/index.d.ts.map +1 -0
  110. package/dist/esm/generated/models/index.js +656 -0
  111. package/dist/esm/generated/models/index.js.map +1 -0
  112. package/dist/esm/generated/models/mappers.d.ts +153 -0
  113. package/dist/esm/generated/models/mappers.d.ts.map +1 -0
  114. package/dist/{index.js → esm/generated/models/mappers.js} +404 -1395
  115. package/dist/esm/generated/models/mappers.js.map +1 -0
  116. package/dist/esm/generated/models/parameters.d.ts +8 -0
  117. package/dist/esm/generated/models/parameters.d.ts.map +1 -0
  118. package/dist/esm/generated/models/parameters.js +61 -0
  119. package/dist/esm/generated/models/parameters.js.map +1 -0
  120. package/dist/esm/index.d.ts +13 -0
  121. package/dist/esm/index.d.ts.map +1 -0
  122. package/dist/esm/index.js +15 -0
  123. package/dist/esm/index.js.map +1 -0
  124. package/dist/esm/models.d.ts +1953 -0
  125. package/dist/esm/models.d.ts.map +1 -0
  126. package/dist/esm/models.js +649 -0
  127. package/dist/esm/models.js.map +1 -0
  128. package/dist/esm/package.json +3 -0
  129. package/dist/react-native/azureKeyCredentialPolicy.d.ts +9 -0
  130. package/dist/react-native/azureKeyCredentialPolicy.d.ts.map +1 -0
  131. package/dist/react-native/azureKeyCredentialPolicy.js +22 -0
  132. package/dist/react-native/azureKeyCredentialPolicy.js.map +1 -0
  133. package/dist/react-native/constants.d.ts +3 -0
  134. package/dist/react-native/constants.d.ts.map +1 -0
  135. package/dist/react-native/constants.js +5 -0
  136. package/dist/react-native/constants.js.map +1 -0
  137. package/dist/react-native/conversationAnalysisClient.d.ts +63 -0
  138. package/dist/react-native/conversationAnalysisClient.d.ts.map +1 -0
  139. package/dist/react-native/conversationAnalysisClient.js +81 -0
  140. package/dist/react-native/conversationAnalysisClient.js.map +1 -0
  141. package/dist/react-native/generated/conversationAnalysisClient.d.ts +36 -0
  142. package/dist/react-native/generated/conversationAnalysisClient.d.ts.map +1 -0
  143. package/dist/react-native/generated/conversationAnalysisClient.js +202 -0
  144. package/dist/react-native/generated/conversationAnalysisClient.js.map +1 -0
  145. package/dist/react-native/generated/index.d.ts +3 -0
  146. package/dist/react-native/generated/index.d.ts.map +1 -0
  147. package/dist/react-native/generated/index.js +10 -0
  148. package/dist/react-native/generated/index.js.map +1 -0
  149. package/dist/react-native/generated/lroImpl.d.ts +16 -0
  150. package/dist/react-native/generated/lroImpl.d.ts.map +1 -0
  151. package/dist/react-native/generated/lroImpl.js +33 -0
  152. package/dist/react-native/generated/lroImpl.js.map +1 -0
  153. package/dist/react-native/generated/models/index.d.ts +1951 -0
  154. package/dist/react-native/generated/models/index.d.ts.map +1 -0
  155. package/dist/react-native/generated/models/index.js +656 -0
  156. package/dist/react-native/generated/models/index.js.map +1 -0
  157. package/dist/react-native/generated/models/mappers.d.ts +153 -0
  158. package/dist/react-native/generated/models/mappers.d.ts.map +1 -0
  159. package/dist/react-native/generated/models/mappers.js +2842 -0
  160. package/dist/react-native/generated/models/mappers.js.map +1 -0
  161. package/dist/react-native/generated/models/parameters.d.ts +8 -0
  162. package/dist/react-native/generated/models/parameters.d.ts.map +1 -0
  163. package/dist/react-native/generated/models/parameters.js +61 -0
  164. package/dist/react-native/generated/models/parameters.js.map +1 -0
  165. package/dist/react-native/index.d.ts +13 -0
  166. package/dist/react-native/index.d.ts.map +1 -0
  167. package/dist/react-native/index.js +15 -0
  168. package/dist/react-native/index.js.map +1 -0
  169. package/dist/react-native/models.d.ts +1953 -0
  170. package/dist/react-native/models.d.ts.map +1 -0
  171. package/dist/react-native/models.js +649 -0
  172. package/dist/react-native/models.js.map +1 -0
  173. package/dist/react-native/package.json +3 -0
  174. package/package.json +95 -100
  175. package/CHANGELOG.md +0 -5
  176. package/dist/index.js.map +0 -1
  177. package/dist-esm/samples-dev/sample_analyze_conversation_app.js +0 -74
  178. package/dist-esm/samples-dev/sample_analyze_conversation_app.js.map +0 -1
  179. package/dist-esm/samples-dev/sample_analyze_orchestration_app_conv_response.js +0 -89
  180. package/dist-esm/samples-dev/sample_analyze_orchestration_app_conv_response.js.map +0 -1
  181. package/dist-esm/samples-dev/sample_analyze_orchestration_app_luis_response.js +0 -65
  182. package/dist-esm/samples-dev/sample_analyze_orchestration_app_luis_response.js.map +0 -1
  183. package/dist-esm/samples-dev/sample_analyze_orchestration_app_qna_response.js +0 -66
  184. package/dist-esm/samples-dev/sample_analyze_orchestration_app_qna_response.js.map +0 -1
  185. package/dist-esm/samples-dev/sample_analyze_orchestration_direct_target.js +0 -76
  186. package/dist-esm/samples-dev/sample_analyze_orchestration_direct_target.js.map +0 -1
  187. package/dist-esm/samples-dev/sample_authentication.js +0 -44
  188. package/dist-esm/samples-dev/sample_authentication.js.map +0 -1
  189. package/dist-esm/samples-dev/sample_conv_pii_transcript_input.js +0 -112
  190. package/dist-esm/samples-dev/sample_conv_pii_transcript_input.js.map +0 -1
  191. package/dist-esm/samples-dev/sample_conv_summarization.js +0 -95
  192. package/dist-esm/samples-dev/sample_conv_summarization.js.map +0 -1
  193. package/dist-esm/src/azureKeyCredentialPolicy.js.map +0 -1
  194. package/dist-esm/src/conversationAnalysisClient.js.map +0 -1
  195. package/dist-esm/src/generated/index.js.map +0 -1
  196. package/dist-esm/src/generated/lroImpl.js.map +0 -1
  197. package/dist-esm/src/generated/models/mappers.js.map +0 -1
  198. package/dist-esm/src/index.js.map +0 -1
  199. package/dist-esm/src/models.js.map +0 -1
  200. package/dist-esm/test/public/analyze.spec.js +0 -159
  201. package/dist-esm/test/public/analyze.spec.js.map +0 -1
  202. package/dist-esm/test/public/inputs.js +0 -166
  203. package/dist-esm/test/public/inputs.js.map +0 -1
  204. package/dist-esm/test/public/utils/recordedClient.js +0 -50
  205. package/dist-esm/test/public/utils/recordedClient.js.map +0 -1
  206. package/review/ai-language-conversations.api.md +0 -1291
  207. package/rollup.config.js +0 -122
  208. package/tsconfig.json +0 -11
  209. package/types/samples-dev/sample_analyze_conversation_app.d.ts +0 -2
  210. package/types/samples-dev/sample_analyze_conversation_app.d.ts.map +0 -1
  211. package/types/samples-dev/sample_analyze_orchestration_app_conv_response.d.ts +0 -2
  212. package/types/samples-dev/sample_analyze_orchestration_app_conv_response.d.ts.map +0 -1
  213. package/types/samples-dev/sample_analyze_orchestration_app_luis_response.d.ts +0 -2
  214. package/types/samples-dev/sample_analyze_orchestration_app_luis_response.d.ts.map +0 -1
  215. package/types/samples-dev/sample_analyze_orchestration_app_qna_response.d.ts +0 -2
  216. package/types/samples-dev/sample_analyze_orchestration_app_qna_response.d.ts.map +0 -1
  217. package/types/samples-dev/sample_analyze_orchestration_direct_target.d.ts +0 -2
  218. package/types/samples-dev/sample_analyze_orchestration_direct_target.d.ts.map +0 -1
  219. package/types/samples-dev/sample_authentication.d.ts +0 -2
  220. package/types/samples-dev/sample_authentication.d.ts.map +0 -1
  221. package/types/samples-dev/sample_conv_pii_transcript_input.d.ts +0 -2
  222. package/types/samples-dev/sample_conv_pii_transcript_input.d.ts.map +0 -1
  223. package/types/samples-dev/sample_conv_summarization.d.ts +0 -2
  224. package/types/samples-dev/sample_conv_summarization.d.ts.map +0 -1
  225. package/types/src/azureKeyCredentialPolicy.d.ts.map +0 -1
  226. package/types/src/conversationAnalysisClient.d.ts.map +0 -1
  227. package/types/src/generated/conversationAnalysisClient.d.ts.map +0 -1
  228. package/types/src/generated/index.d.ts +0 -3
  229. package/types/src/generated/models/index.d.ts.map +0 -1
  230. package/types/src/models.d.ts.map +0 -1
  231. package/types/test/public/analyze.spec.d.ts +0 -2
  232. package/types/test/public/analyze.spec.d.ts.map +0 -1
  233. package/types/test/public/inputs.d.ts +0 -8
  234. package/types/test/public/inputs.d.ts.map +0 -1
  235. package/types/test/public/utils/recordedClient.d.ts +0 -16
  236. package/types/test/public/utils/recordedClient.d.ts.map +0 -1
  237. /package/{types/src → dist/browser}/constants.d.ts +0 -0
  238. /package/{types/src → dist/browser}/constants.d.ts.map +0 -0
  239. /package/{types/src → dist/browser}/generated/lroImpl.d.ts +0 -0
  240. /package/{types/src → dist/browser}/generated/lroImpl.d.ts.map +0 -0
  241. /package/{dist-esm/src → dist/browser}/generated/models/index.js +0 -0
  242. /package/{dist-esm/src → dist/browser}/generated/models/index.js.map +0 -0
  243. /package/{types/src → dist/browser}/generated/models/mappers.d.ts +0 -0
  244. /package/{types/src → dist/browser}/generated/models/mappers.d.ts.map +0 -0
  245. /package/{types/src → dist/browser}/generated/models/parameters.d.ts +0 -0
  246. /package/{types/src → dist/browser}/generated/models/parameters.d.ts.map +0 -0
@@ -0,0 +1,1953 @@
1
+ import type * as coreClient from "@azure/core-client";
2
+ export type AnalyzeConversationTaskUnion = ConversationalTask;
3
+ export type AnalyzeConversationTaskResultUnion = ConversationalTaskResult;
4
+ export type ConversationUnion = TextConversation | TranscriptConversation;
5
+ export type AnalysisParametersUnion = LuisParameters | ConversationParameters | QuestionAnsweringParameters;
6
+ export type BasePredictionUnion = ConversationPrediction | OrchestrationPrediction;
7
+ export type BaseResolutionUnion = AgeResolution | VolumeResolution | SpeedResolution | AreaResolution | LengthResolution | InformationResolution | TemperatureResolution | WeightResolution | CurrencyResolution | BooleanResolution | DateTimeResolution | NumberResolution | OrdinalResolution | TemporalSpanResolution | NumericRangeResolution;
8
+ export type BaseExtraInformationUnion = EntitySubtype | ListKey;
9
+ export type TargetIntentResultUnion = NoneLinkedTargetIntentResult | ConversationTargetIntentResult | LuisTargetIntentResult | QuestionAnsweringTargetIntentResult;
10
+ export type AnalyzeConversationLROTaskUnion = AnalyzeConversationPIITask | AnalyzeConversationSummarizationTask;
11
+ export type AnalyzeConversationJobResultUnion = AnalyzeConversationPIIResult | AnalyzeConversationSummarizationResult;
12
+ /** The base class of a conversation input task. */
13
+ export interface AnalyzeConversationTask {
14
+ /** Polymorphic discriminator, which specifies the different types this object can be */
15
+ kind: "Conversation";
16
+ }
17
+ /** The base class of a conversation task result. */
18
+ export interface AnalyzeConversationTaskResult {
19
+ /** Polymorphic discriminator, which specifies the different types this object can be */
20
+ kind: "ConversationResult";
21
+ }
22
+ /** Error response. */
23
+ export interface ErrorResponse {
24
+ /** The error object. */
25
+ error: ErrorModel;
26
+ }
27
+ /** The error object. */
28
+ export interface ErrorModel {
29
+ /** Describes unknown properties. The value of an unknown property can be of "any" type. */
30
+ [property: string]: any;
31
+ /** One of a server-defined set of error codes. */
32
+ code: ErrorCode;
33
+ /** A human-readable representation of the error. */
34
+ message: string;
35
+ /** The target of the error. */
36
+ target?: string;
37
+ /** An array of details about specific errors that led to this reported error. */
38
+ details?: ErrorModel[];
39
+ /** An object containing more specific information than the current object about the error. */
40
+ innererror?: InnerErrorModel;
41
+ }
42
+ /** An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. */
43
+ export interface InnerErrorModel {
44
+ /** One of a server-defined set of error codes. */
45
+ code: InnerErrorCode;
46
+ /** Error message. */
47
+ message: string;
48
+ /** Error details. */
49
+ details?: {
50
+ [propertyName: string]: string;
51
+ };
52
+ /** Error target. */
53
+ target?: string;
54
+ /** An object containing more specific information than the current object about the error. */
55
+ innererror?: InnerErrorModel;
56
+ }
57
+ export interface AnalyzeConversationJobsInput {
58
+ /** Optional display name for the analysis job. */
59
+ displayName?: string;
60
+ analysisInput: MultiLanguageConversationAnalysisInput;
61
+ /** The set of tasks to execute on the input conversation. */
62
+ tasks: AnalyzeConversationLROTaskUnion[];
63
+ }
64
+ export interface MultiLanguageConversationAnalysisInput {
65
+ conversations: ConversationUnion[];
66
+ }
67
+ /** A complete ordered set of utterances (spoken or written), by one or more speakers to be used for analysis. */
68
+ export interface Conversation {
69
+ /** Polymorphic discriminator, which specifies the different types this object can be */
70
+ modality: "text" | "transcript";
71
+ /** Unique identifier for the conversation. */
72
+ id: string;
73
+ /** The language of the conversation item in BCP-47 format. */
74
+ language: string;
75
+ /** Enumeration of supported conversational domains. */
76
+ domain?: ConversationDomain;
77
+ }
78
+ /** Base task object. */
79
+ export interface TaskIdentifier {
80
+ taskName?: string;
81
+ }
82
+ export interface JobStateAutoGenerated {
83
+ displayName?: string;
84
+ createdDateTime: Date;
85
+ expirationDateTime?: Date;
86
+ jobId: string;
87
+ lastUpdatedDateTime: Date;
88
+ status: JobState;
89
+ errors?: ErrorModel[];
90
+ nextLink?: string;
91
+ }
92
+ /** Contains the state for the tasks being executed as part of the analyze conversation job submitted. */
93
+ export interface ConversationTasksState {
94
+ tasks: ConversationTasksStateTasks;
95
+ }
96
+ export interface ConversationTasksStateTasks {
97
+ /** Count of tasks completed successfully. */
98
+ completed: number;
99
+ /** Count of tasks that failed. */
100
+ failed: number;
101
+ /** Count of tasks in progress currently. */
102
+ inProgress: number;
103
+ /** Total count of tasks submitted as part of the job. */
104
+ total: number;
105
+ /** List of results from tasks (if available). */
106
+ items?: AnalyzeConversationJobResultUnion[];
107
+ }
108
+ /** Returns the current state of the task. */
109
+ export interface TaskStateAutoGenerated {
110
+ /** The last updated time in UTC for the task. */
111
+ lastUpdateDateTime: Date;
112
+ /** The status of the task at the mentioned last update time. */
113
+ status: TaskState;
114
+ }
115
+ /** Contains the statistics for the job submitted. */
116
+ export interface AnalyzeConversationJobStatistics {
117
+ /** if showStats=true was specified in the request this field will contain information about the request payload. */
118
+ statistics?: ConversationRequestStatistics;
119
+ }
120
+ /** if showStats=true was specified in the request this field will contain information about the request payload. */
121
+ export interface RequestStatistics {
122
+ /** Describes unknown properties. The value of an unknown property can be of "any" type. */
123
+ [property: string]: any;
124
+ /** Number of transactions for the request. */
125
+ transactionsCount: number;
126
+ }
127
+ /** The input ConversationItem and its optional parameters */
128
+ export interface ConversationAnalysisOptions {
129
+ /** The abstract base for a user input formatted conversation (e.g., Text, Transcript). */
130
+ conversationItem: ConversationItemBase;
131
+ }
132
+ /** The abstract base for a user input formatted conversation (e.g., Text, Transcript). */
133
+ export interface ConversationItemBase {
134
+ /** Describes unknown properties. The value of an unknown property can be of "any" type. */
135
+ [property: string]: any;
136
+ /** The ID of a conversation item. */
137
+ id: string;
138
+ /** The participant ID of a conversation item. */
139
+ participantId: string;
140
+ /** The override language of a conversation item in BCP 47 language representation. */
141
+ language?: string;
142
+ /** Enumeration of supported conversational modalities. */
143
+ modality?: InputModality;
144
+ /** The role of the participant. */
145
+ role?: Role;
146
+ }
147
+ /** Input parameters necessary for a Conversation task. */
148
+ export interface ConversationTaskParameters {
149
+ /** The name of the project to use. */
150
+ projectName: string;
151
+ /** The name of the deployment to use. */
152
+ deploymentName: string;
153
+ /** If true, the service will return more detailed information in the response. */
154
+ verbose?: boolean;
155
+ /** If true, the service will keep the query for further review. */
156
+ isLoggingEnabled?: boolean;
157
+ /** 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. */
158
+ stringIndexType?: StringIndexType;
159
+ /** The name of a target project to forward the request to. */
160
+ directTarget?: string;
161
+ /** A dictionary representing the parameters for each target project. */
162
+ targetProjectParameters?: {
163
+ [propertyName: string]: AnalysisParametersUnion;
164
+ };
165
+ }
166
+ /** This is the parameter set of either the Orchestration project itself or one of the target services. */
167
+ export interface AnalysisParameters {
168
+ /** Polymorphic discriminator, which specifies the different types this object can be */
169
+ targetProjectKind: "Luis" | "Conversation" | "QuestionAnswering";
170
+ /** The API version to use when call a specific target service. */
171
+ apiVersion?: string;
172
+ }
173
+ /** Represents a conversation analysis response. */
174
+ export interface AnalyzeConversationResult {
175
+ /** The conversation utterance given by the caller. */
176
+ query: string;
177
+ /** The system detected language for the query in BCP 47 language representation.. */
178
+ detectedLanguage?: string;
179
+ /** The prediction result of a conversation project. */
180
+ prediction: BasePredictionUnion;
181
+ }
182
+ /** This is the base class of prediction */
183
+ export interface BasePrediction {
184
+ /** Polymorphic discriminator, which specifies the different types this object can be */
185
+ projectKind: "Conversation" | "Orchestration";
186
+ /** The intent with the highest score. */
187
+ topIntent?: string;
188
+ }
189
+ /** The response returned by a Conversation project. */
190
+ export interface ConversationResult {
191
+ /** The same query given in request. */
192
+ query: string;
193
+ /** The detected language from the query in BCP 47 language representation.. */
194
+ detectedLanguage?: string;
195
+ /** The predicted result for the query. */
196
+ prediction?: ConversationPrediction;
197
+ }
198
+ /** The intent classification result of a Conversation project. */
199
+ export interface ConversationIntent {
200
+ /** A predicted class. */
201
+ category: string;
202
+ /** The confidence score of the class from 0.0 to 1.0. */
203
+ confidence: number;
204
+ }
205
+ /** The entity extraction result of a Conversation project. */
206
+ export interface ConversationEntity {
207
+ /** The entity category. */
208
+ category: string;
209
+ /** The predicted entity text. */
210
+ text: string;
211
+ /** The starting index of this entity in the query. */
212
+ offset: number;
213
+ /** The length of the text. */
214
+ length: number;
215
+ /** The entity confidence score. */
216
+ confidence: number;
217
+ /** The collection of entity resolution objects. */
218
+ resolutions?: BaseResolutionUnion[];
219
+ /** The collection of entity extra information objects. */
220
+ extraInformation?: BaseExtraInformationUnion[];
221
+ }
222
+ /** The abstract base class for entity resolutions. */
223
+ export interface BaseResolution {
224
+ /** Polymorphic discriminator, which specifies the different types this object can be */
225
+ resolutionKind: "Age" | "Volume" | "Speed" | "Area" | "Length" | "Information" | "Temperature" | "Weight" | "Currency" | "Boolean" | "DateTime" | "Number" | "Ordinal" | "TemporalSpan" | "NumericRange";
226
+ }
227
+ /** The abstract base object for entity extra information. */
228
+ export interface BaseExtraInformation {
229
+ /** Polymorphic discriminator, which specifies the different types this object can be */
230
+ extraInformationKind: "EntitySubtype" | "ListKey";
231
+ }
232
+ /** This is the base class of an intent prediction */
233
+ export interface TargetIntentResult {
234
+ /** Polymorphic discriminator, which specifies the different types this object can be */
235
+ targetProjectKind: "NonLinked" | "Conversation" | "Luis" | "QuestionAnswering";
236
+ /** The API version used to call a target service. */
237
+ apiVersion?: string;
238
+ /** The prediction score and it ranges from 0.0 to 1.0. */
239
+ confidence: number;
240
+ }
241
+ /** This customizes how the service calls LUIS Generally Available projects. */
242
+ export interface LuisCallingOptions {
243
+ /** Enable verbose response. */
244
+ verbose?: boolean;
245
+ /** Save log to add in training utterances later. */
246
+ log?: boolean;
247
+ /** Set true to show all intents. */
248
+ showAllIntents?: boolean;
249
+ /** The timezone offset for the location of the request. */
250
+ timezoneOffset?: number;
251
+ /** Enable spell checking. */
252
+ spellCheck?: boolean;
253
+ /** The subscription key to use when enabling Bing spell check */
254
+ bingSpellCheckSubscriptionKey?: string;
255
+ }
256
+ /** The option to set to call a Conversation project. */
257
+ export interface ConversationCallingOptions {
258
+ /** The language of the query in BCP 47 language representation.. */
259
+ language?: string;
260
+ /** If true, the service will return more detailed information. */
261
+ verbose?: boolean;
262
+ /** If true, the query will be saved for customers to further review in authoring, to improve the model quality. */
263
+ isLoggingEnabled?: boolean;
264
+ }
265
+ /** Parameters to query a knowledge base. */
266
+ export interface AnswersOptions {
267
+ /** Exact QnA ID to fetch from the knowledge base, this field takes priority over question. */
268
+ qnaId?: number;
269
+ /** User question to query against the knowledge base. */
270
+ question?: string;
271
+ /** Max number of answers to be returned for the question. */
272
+ top?: number;
273
+ /** Unique identifier for the user. */
274
+ userId?: string;
275
+ /** Minimum threshold score for answers, value ranges from 0 to 1. */
276
+ confidenceThreshold?: number;
277
+ /** Context object with previous QnA's information. */
278
+ answerContext?: KnowledgeBaseAnswerContext;
279
+ /** Type of ranker to be used. */
280
+ rankerKind?: RankerKind;
281
+ /** Filter QnAs based on given metadata list and knowledge base sources. */
282
+ filters?: QueryFilters;
283
+ /** To configure Answer span prediction feature. */
284
+ shortAnswerOptions?: ShortAnswerOptions;
285
+ /** (Optional) Flag to enable Query over Unstructured Sources. */
286
+ includeUnstructuredSources?: boolean;
287
+ }
288
+ /** Context object with previous QnA's information. */
289
+ export interface KnowledgeBaseAnswerContext {
290
+ /** Previous turn top answer result QnA ID. */
291
+ previousQnaId: number;
292
+ /** Previous user query. */
293
+ previousQuestion?: string;
294
+ }
295
+ /** filters over knowledge base. */
296
+ export interface QueryFilters {
297
+ /** Find QnAs that are associated with the given list of metadata. */
298
+ metadataFilter?: MetadataFilter;
299
+ /** Find QnAs that are associated with any of the given list of sources in knowledge base. */
300
+ sourceFilter?: string[];
301
+ /** Logical operation used to join metadata filter with source filter. */
302
+ logicalOperation?: LogicalOperationKind;
303
+ }
304
+ /** Find QnAs that are associated with the given list of metadata. */
305
+ export interface MetadataFilter {
306
+ metadata?: MetadataRecord[];
307
+ /** Operation used to join metadata filters. */
308
+ logicalOperation?: LogicalOperationKind;
309
+ }
310
+ /** Object to provide the key value pair for each metadata. */
311
+ export interface MetadataRecord {
312
+ /** Metadata Key from Metadata dictionary used in the QnA. */
313
+ key: string;
314
+ /** Metadata Value from Metadata dictionary used in the QnA. */
315
+ value: string;
316
+ }
317
+ /** To configure Answer span prediction feature. */
318
+ export interface ShortAnswerOptions {
319
+ /** Enable or disable Answer Span prediction. */
320
+ enable: true;
321
+ /** Minimum threshold score required to include an answer span, value ranges from 0 to 1. */
322
+ confidenceThreshold?: number;
323
+ /** Number of Top answers to be considered for span prediction from 1 to 10. */
324
+ top?: number;
325
+ }
326
+ /** Represents resolutions for quantities. */
327
+ export interface QuantityResolution {
328
+ /** The numeric value that the extracted text denotes. */
329
+ value: number;
330
+ }
331
+ /** Represents List of Question Answers. */
332
+ export interface AnswersResult {
333
+ /** Represents Answer Result list. */
334
+ answers?: KnowledgeBaseAnswer[];
335
+ }
336
+ /** Represents knowledge base answer. */
337
+ export interface KnowledgeBaseAnswer {
338
+ /** List of questions associated with the answer. */
339
+ questions?: string[];
340
+ /** Answer text. */
341
+ answer?: string;
342
+ /** Answer confidence score, value ranges from 0 to 1. */
343
+ confidence?: number;
344
+ /** ID of the QnA result. */
345
+ qnaId?: number;
346
+ /** Source of QnA result. */
347
+ source?: string;
348
+ /** Metadata associated with the answer, useful to categorize or filter question answers. */
349
+ metadata?: {
350
+ [propertyName: string]: string;
351
+ };
352
+ /** Dialog associated with Answer. */
353
+ dialog?: KnowledgeBaseAnswerDialog;
354
+ /** Answer span object of QnA with respect to user's question. */
355
+ shortAnswer?: AnswerSpan;
356
+ }
357
+ /** Dialog associated with Answer. */
358
+ export interface KnowledgeBaseAnswerDialog {
359
+ /** To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result. */
360
+ isContextOnly?: boolean;
361
+ /** List of prompts associated with the answer. */
362
+ prompts?: KnowledgeBaseAnswerPrompt[];
363
+ }
364
+ /** Prompt for an answer. */
365
+ export interface KnowledgeBaseAnswerPrompt {
366
+ /** Index of the prompt - used in ordering of the prompts. */
367
+ displayOrder?: number;
368
+ /** QnA ID corresponding to the prompt. */
369
+ qnaId?: number;
370
+ /** Text displayed to represent a follow up question prompt. */
371
+ displayText?: string;
372
+ }
373
+ /** Answer span object of QnA. */
374
+ export interface AnswerSpan {
375
+ /** Predicted text of answer span. */
376
+ text?: string;
377
+ /** Predicted score of answer span, value ranges from 0 to 1. */
378
+ confidence?: number;
379
+ /** The answer span offset from the start of answer. */
380
+ offset?: number;
381
+ /** The length of the answer span. */
382
+ length?: number;
383
+ }
384
+ /** Base parameters object for a text analysis task. */
385
+ export interface TaskParameters {
386
+ loggingOptOut?: boolean;
387
+ }
388
+ export interface ConversationPIIItemResult {
389
+ id: string;
390
+ /** The transcript content response generated by the service with all necessary personally identifiable information redacted. */
391
+ redactedContent: RedactedTranscriptContent;
392
+ entities: Entity[];
393
+ }
394
+ /** The transcript content response generated by the service with all necessary personally identifiable information redacted. */
395
+ export interface RedactedTranscriptContent {
396
+ /** The redacted output for inverse text normalized format input. */
397
+ itn?: string;
398
+ /** The redacted output for masked inverse text normalized format input. */
399
+ maskedItn?: string;
400
+ /** The redacted output for text (Microsoft's Speech to Text 'display') format input. */
401
+ text?: string;
402
+ /** The redacted output for lexical format input. */
403
+ lexical?: string;
404
+ /** The list of redacted audio segments. */
405
+ audioTimings?: AudioTiming[];
406
+ }
407
+ /** The audio timing information. */
408
+ export interface AudioTiming {
409
+ /** Offset from start of speech audio, in ticks. 1 tick = 100 ns. */
410
+ offset?: number;
411
+ /** Duration of word articulation, in ticks. 1 tick = 100 ns. */
412
+ duration?: number;
413
+ }
414
+ export interface Entity {
415
+ /** Entity text as appears in the request. */
416
+ text: string;
417
+ /** Entity type. */
418
+ category: string;
419
+ /** (Optional) Entity sub type. */
420
+ subcategory?: string;
421
+ /** Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned. */
422
+ offset: number;
423
+ /** Length for the entity text. Use of different 'stringIndexType' values can affect the length returned. */
424
+ length: number;
425
+ /** Confidence score between 0 and 1 of the extracted entity. */
426
+ confidenceScore: number;
427
+ }
428
+ /** The result from PII detection and redaction operation for each conversation. */
429
+ export interface ConversationPIIResult {
430
+ /** Enumeration of PII detection and redaction operation results for all the conversation items in a conversation. */
431
+ conversationItems: ConversationPIIItemResult[];
432
+ }
433
+ /** Shared attributes for all conversational task results. */
434
+ export interface ConversationResultBase {
435
+ /** Unique, non-empty conversation identifier. */
436
+ id: string;
437
+ /** Warnings encountered while processing document. */
438
+ warnings: InputWarning[];
439
+ /** If showStats=true was specified in the request this field will contain information about the conversation payload. */
440
+ statistics?: ConversationStatistics;
441
+ }
442
+ /** Contains details of warnings encountered during a job execution. */
443
+ export interface InputWarning {
444
+ /** Warning code. */
445
+ code: string;
446
+ /** Warning message. */
447
+ message: string;
448
+ /** A JSON pointer reference indicating the target object. */
449
+ targetRef?: string;
450
+ }
451
+ /** If showStats=true was specified in the request this field will contain information about the conversation payload. */
452
+ export interface ConversationStatistics {
453
+ /** Number of text units for the request. */
454
+ transactionsCount: number;
455
+ }
456
+ export interface PreBuiltResult {
457
+ /** Errors by document id. */
458
+ errors: InputError[];
459
+ /** if showStats=true was specified in the request this field will contain information about the request payload. */
460
+ statistics?: RequestStatistics;
461
+ /** This field indicates which model is used for scoring. */
462
+ modelVersion: string;
463
+ }
464
+ /** Contains details of errors encountered during a job execution. */
465
+ export interface InputError {
466
+ /** The ID of the input. */
467
+ id: string;
468
+ /** Error encountered. */
469
+ error: ErrorModel;
470
+ }
471
+ export interface ConversationsSummaryResult {
472
+ summaries: ConversationsSummaryResultSummariesItem[];
473
+ }
474
+ export interface SummaryResultItem {
475
+ aspect: string;
476
+ text: string;
477
+ }
478
+ /** The input for a custom conversation task. */
479
+ export interface ConversationalTask extends AnalyzeConversationTask {
480
+ /** Polymorphic discriminator, which specifies the different types this object can be */
481
+ kind: "Conversation";
482
+ /** The input ConversationItem and its optional parameters */
483
+ analysisInput: ConversationAnalysisOptions;
484
+ /** Input parameters necessary for a Conversation task. */
485
+ parameters: ConversationTaskParameters;
486
+ }
487
+ /** The results of a Conversation task. */
488
+ export interface ConversationalTaskResult extends AnalyzeConversationTaskResult {
489
+ /** Polymorphic discriminator, which specifies the different types this object can be */
490
+ kind: "ConversationResult";
491
+ /** Represents a conversation analysis response. */
492
+ result: AnalyzeConversationResult;
493
+ }
494
+ export interface TextConversation extends Conversation {
495
+ /** Polymorphic discriminator, which specifies the different types this object can be */
496
+ modality: "text";
497
+ /** Ordered list of text conversation items in the conversation. */
498
+ conversationItems: TextConversationItem[];
499
+ }
500
+ export interface TranscriptConversation extends Conversation {
501
+ /** Polymorphic discriminator, which specifies the different types this object can be */
502
+ modality: "transcript";
503
+ /** Ordered list of transcript conversation items in the conversation. */
504
+ conversationItems: TranscriptConversationItem[];
505
+ }
506
+ /** The base class for an long running conversation input task. */
507
+ export interface AnalyzeConversationLROTask extends TaskIdentifier {
508
+ /** Enumeration of supported analysis tasks on a collection of conversations. */
509
+ kind: AnalyzeConversationLROTaskKind;
510
+ }
511
+ /** Container for results for all tasks in the conversation job. */
512
+ export interface AnalyzeConversationJobResult extends TaskStateAutoGenerated, TaskIdentifier {
513
+ /** Enumeration of supported Conversation Analysis task results. */
514
+ kind: AnalyzeConversationResultsKind;
515
+ }
516
+ /** Contains the status of the analyze conversations job submitted along with related statistics. */
517
+ export interface AnalyzeConversationJobState extends JobStateAutoGenerated, ConversationTasksState, AnalyzeConversationJobStatistics {
518
+ }
519
+ /** if showStats=true was specified in the request this field will contain information about the request payload. */
520
+ export interface ConversationRequestStatistics extends RequestStatistics {
521
+ /** Number of conversations submitted in the request. */
522
+ conversationsCount: number;
523
+ /** Number of conversations documents. This excludes empty, over-size limit or non-supported languages documents. */
524
+ validConversationsCount: number;
525
+ /** Number of invalid documents. This includes empty, over-size limit or non-supported languages documents. */
526
+ erroneousConversationsCount: number;
527
+ }
528
+ /** The text modality of an input conversation. */
529
+ export interface TextConversationItem extends ConversationItemBase {
530
+ /** The text input */
531
+ text: string;
532
+ }
533
+ /** Additional properties for supporting transcript conversation. */
534
+ export interface TranscriptConversationItem extends ConversationItemBase {
535
+ /** Inverse Text Normalization representation of input. The inverse-text-normalized form is the recognized text from Microsoft’s Speech to Text API, with phone numbers, numbers, abbreviations, and other transformations applied. */
536
+ itn?: string;
537
+ /** The Inverse Text Normalized format with profanity masking applied. */
538
+ maskedItn?: string;
539
+ /** The display form of the recognized text from speech to text API, with punctuation and capitalization added. */
540
+ text?: string;
541
+ /** The lexical form of the recognized text from speech to text API with the actual words recognized. */
542
+ lexical?: string;
543
+ /** The list of word level audio timing information */
544
+ audioTimings?: WordLevelTiming[];
545
+ }
546
+ /** This is a set of request parameters for LUIS Generally Available projects. */
547
+ export interface LuisParameters extends AnalysisParameters {
548
+ /** Polymorphic discriminator, which specifies the different types this object can be */
549
+ targetProjectKind: "Luis";
550
+ /** Describes unknown properties. The value of an unknown property can be of "any" type. */
551
+ [property: string]: any;
552
+ /** The utterance to predict. */
553
+ query?: string;
554
+ /** This customizes how the service calls LUIS Generally Available projects. */
555
+ callingOptions?: LuisCallingOptions;
556
+ }
557
+ /** This is a set of request parameters for Customized Conversation projects. */
558
+ export interface ConversationParameters extends AnalysisParameters {
559
+ /** Polymorphic discriminator, which specifies the different types this object can be */
560
+ targetProjectKind: "Conversation";
561
+ /** The option to set to call a Conversation project. */
562
+ callingOptions?: ConversationCallingOptions;
563
+ }
564
+ /** This is a set of request parameters for Question Answering knowledge bases. */
565
+ export interface QuestionAnsweringParameters extends AnalysisParameters {
566
+ /** Polymorphic discriminator, which specifies the different types this object can be */
567
+ targetProjectKind: "QuestionAnswering";
568
+ /** The options sent to a Question Answering KB. */
569
+ callingOptions?: AnswersOptions;
570
+ }
571
+ /** Represents the prediction section of a Conversation project. */
572
+ export interface ConversationPrediction extends BasePrediction {
573
+ /** Polymorphic discriminator, which specifies the different types this object can be */
574
+ projectKind: "Conversation";
575
+ /** The intent classification results. */
576
+ intents: ConversationIntent[];
577
+ /** The entity extraction results. */
578
+ entities: ConversationEntity[];
579
+ }
580
+ /** This represents the prediction result of an Orchestration project. */
581
+ export interface OrchestrationPrediction extends BasePrediction {
582
+ /** Polymorphic discriminator, which specifies the different types this object can be */
583
+ projectKind: "Orchestration";
584
+ /** A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project. */
585
+ intents: {
586
+ [propertyName: string]: TargetIntentResultUnion;
587
+ };
588
+ }
589
+ /** Represents the Age entity resolution model. */
590
+ export interface AgeResolution extends BaseResolution, QuantityResolution {
591
+ /** Polymorphic discriminator, which specifies the different types this object can be */
592
+ resolutionKind: "Age";
593
+ /** The Age Unit of measurement */
594
+ unit: AgeUnit;
595
+ }
596
+ /** Represents the volume entity resolution model. */
597
+ export interface VolumeResolution extends BaseResolution, QuantityResolution {
598
+ /** Polymorphic discriminator, which specifies the different types this object can be */
599
+ resolutionKind: "Volume";
600
+ /** The Volume Unit of measurement */
601
+ unit: VolumeUnit;
602
+ }
603
+ /** Represents the speed entity resolution model. */
604
+ export interface SpeedResolution extends BaseResolution, QuantityResolution {
605
+ /** Polymorphic discriminator, which specifies the different types this object can be */
606
+ resolutionKind: "Speed";
607
+ /** The speed Unit of measurement */
608
+ unit: SpeedUnit;
609
+ }
610
+ /** Represents the area entity resolution model. */
611
+ export interface AreaResolution extends BaseResolution, QuantityResolution {
612
+ /** Polymorphic discriminator, which specifies the different types this object can be */
613
+ resolutionKind: "Area";
614
+ /** The area Unit of measurement */
615
+ unit: AreaUnit;
616
+ }
617
+ /** Represents the length entity resolution model. */
618
+ export interface LengthResolution extends BaseResolution, QuantityResolution {
619
+ /** Polymorphic discriminator, which specifies the different types this object can be */
620
+ resolutionKind: "Length";
621
+ /** The length Unit of measurement */
622
+ unit: LengthUnit;
623
+ }
624
+ /** Represents the information (data) entity resolution model. */
625
+ export interface InformationResolution extends BaseResolution, QuantityResolution {
626
+ /** Polymorphic discriminator, which specifies the different types this object can be */
627
+ resolutionKind: "Information";
628
+ /** The information (data) Unit of measurement. */
629
+ unit: InformationUnit;
630
+ }
631
+ /** Represents the temperature entity resolution model. */
632
+ export interface TemperatureResolution extends BaseResolution, QuantityResolution {
633
+ /** Polymorphic discriminator, which specifies the different types this object can be */
634
+ resolutionKind: "Temperature";
635
+ /** The temperature Unit of measurement. */
636
+ unit: TemperatureUnit;
637
+ }
638
+ /** Represents the weight entity resolution model. */
639
+ export interface WeightResolution extends BaseResolution, QuantityResolution {
640
+ /** Polymorphic discriminator, which specifies the different types this object can be */
641
+ resolutionKind: "Weight";
642
+ /** The weight Unit of measurement. */
643
+ unit: WeightUnit;
644
+ }
645
+ /** Represents the currency entity resolution model. */
646
+ export interface CurrencyResolution extends BaseResolution, QuantityResolution {
647
+ /** Polymorphic discriminator, which specifies the different types this object can be */
648
+ resolutionKind: "Currency";
649
+ /** 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. */
650
+ iso4217?: string;
651
+ /** The unit of the amount captured in the extracted entity */
652
+ unit: string;
653
+ }
654
+ /** A resolution for boolean expressions */
655
+ export interface BooleanResolution extends BaseResolution {
656
+ /** Polymorphic discriminator, which specifies the different types this object can be */
657
+ resolutionKind: "Boolean";
658
+ value: boolean;
659
+ }
660
+ /** A resolution for datetime entity instances. */
661
+ export interface DateTimeResolution extends BaseResolution {
662
+ /** Polymorphic discriminator, which specifies the different types this object can be */
663
+ resolutionKind: "DateTime";
664
+ /** An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) */
665
+ timex: string;
666
+ /** The DateTime SubKind */
667
+ dateTimeSubKind: DateTimeSubKind;
668
+ /** The actual time that the extracted text denote. */
669
+ value: string;
670
+ /** An optional modifier of a date/time instance. */
671
+ modifier?: TemporalModifier;
672
+ }
673
+ /** A resolution for numeric entity instances. */
674
+ export interface NumberResolution extends BaseResolution {
675
+ /** Polymorphic discriminator, which specifies the different types this object can be */
676
+ resolutionKind: "Number";
677
+ /** The type of the extracted number entity. */
678
+ numberKind: NumberKind;
679
+ /** A numeric representation of what the extracted text denotes. */
680
+ value: string;
681
+ }
682
+ /** A resolution for ordinal numbers entity instances. */
683
+ export interface OrdinalResolution extends BaseResolution {
684
+ /** Polymorphic discriminator, which specifies the different types this object can be */
685
+ resolutionKind: "Ordinal";
686
+ /** The offset With respect to the reference (e.g., offset = -1 in "show me the second to last" */
687
+ offset: string;
688
+ /** The reference point that the ordinal number denotes. */
689
+ relativeTo: RelativeTo;
690
+ /** A simple arithmetic expression that the ordinal denotes. */
691
+ value: string;
692
+ }
693
+ /** represents the resolution of a date and/or time span. */
694
+ export interface TemporalSpanResolution extends BaseResolution {
695
+ /** Polymorphic discriminator, which specifies the different types this object can be */
696
+ resolutionKind: "TemporalSpan";
697
+ /** An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) */
698
+ begin?: string;
699
+ /** An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml) */
700
+ end?: string;
701
+ /** An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations) */
702
+ duration?: string;
703
+ /** An optional modifier of a date/time instance. */
704
+ modifier?: TemporalModifier;
705
+ }
706
+ /** represents the resolution of numeric intervals. */
707
+ export interface NumericRangeResolution extends BaseResolution {
708
+ /** Polymorphic discriminator, which specifies the different types this object can be */
709
+ resolutionKind: "NumericRange";
710
+ /** The kind of range that the resolution object represents. */
711
+ rangeKind: RangeKind;
712
+ /** The beginning value of the interval. */
713
+ minimum: number;
714
+ /** The ending value of the interval. */
715
+ maximum: number;
716
+ }
717
+ /** The concrete entity Subtype model of extra information. */
718
+ export interface EntitySubtype extends BaseExtraInformation {
719
+ /** Polymorphic discriminator, which specifies the different types this object can be */
720
+ extraInformationKind: "EntitySubtype";
721
+ /** The Subtype of an extracted entity type. */
722
+ value?: string;
723
+ }
724
+ /** The list key extra data kind. */
725
+ export interface ListKey extends BaseExtraInformation {
726
+ /** Polymorphic discriminator, which specifies the different types this object can be */
727
+ extraInformationKind: "ListKey";
728
+ /** The canonical form of the extracted entity. */
729
+ key?: string;
730
+ }
731
+ /** A wrap up of non-linked intent response. */
732
+ export interface NoneLinkedTargetIntentResult extends TargetIntentResult {
733
+ /** Polymorphic discriminator, which specifies the different types this object can be */
734
+ targetProjectKind: "NonLinked";
735
+ /** The actual response from a Conversation project. */
736
+ result?: ConversationResult;
737
+ }
738
+ /** A wrap up of Conversation project response. */
739
+ export interface ConversationTargetIntentResult extends TargetIntentResult {
740
+ /** Polymorphic discriminator, which specifies the different types this object can be */
741
+ targetProjectKind: "Conversation";
742
+ /** The actual response from a Conversation project. */
743
+ result?: ConversationResult;
744
+ }
745
+ /** It is a wrap up of LUIS Generally Available response. */
746
+ export interface LuisTargetIntentResult extends TargetIntentResult {
747
+ /** Polymorphic discriminator, which specifies the different types this object can be */
748
+ targetProjectKind: "Luis";
749
+ /** The actual response from a LUIS Generally Available application. */
750
+ result?: Record<string, ConversationPrediction>;
751
+ }
752
+ /** It is a wrap up a Question Answering KB response. */
753
+ export interface QuestionAnsweringTargetIntentResult extends TargetIntentResult {
754
+ /** Polymorphic discriminator, which specifies the different types this object can be */
755
+ targetProjectKind: "QuestionAnswering";
756
+ /** The generated answer by a Question Answering KB. */
757
+ result?: AnswersResult;
758
+ }
759
+ /** Parameters object for a text analysis task using pre-built models. */
760
+ export interface PreBuiltTaskParameters extends TaskParameters {
761
+ modelVersion?: string;
762
+ }
763
+ /** Word level timing information generated by the speech to text API. The words in this object should have 1:1 correspondence with the 'lexical' input to allow for audio redaction. */
764
+ export interface WordLevelTiming extends AudioTiming {
765
+ /** The word recognized. */
766
+ word?: string;
767
+ }
768
+ export interface ConversationPIIResultsConversationsItem extends ConversationPIIResult, ConversationResultBase {
769
+ }
770
+ export interface SummaryResultConversationsItem extends ConversationsSummaryResult, ConversationResultBase {
771
+ }
772
+ /** The result from PII detection and redaction operation for each conversation. */
773
+ export interface ConversationPIIResults extends PreBuiltResult {
774
+ conversations: ConversationPIIResultsConversationsItem[];
775
+ }
776
+ export interface SummaryResult extends PreBuiltResult {
777
+ conversations: SummaryResultConversationsItem[];
778
+ }
779
+ export interface ConversationsSummaryResultSummariesItem extends SummaryResultItem {
780
+ }
781
+ /** Task definition for a PII redaction in conversations. */
782
+ export interface AnalyzeConversationPIITask extends AnalyzeConversationLROTask {
783
+ /** Supported parameters for a Conversational PII detection and redaction task. */
784
+ parameters?: ConversationPIITaskParameters;
785
+ }
786
+ /** Task definition for conversational summarization. */
787
+ export interface AnalyzeConversationSummarizationTask extends AnalyzeConversationLROTask {
788
+ /** Supported parameters for an conversational summarization task. */
789
+ parameters?: ConversationSummarizationTaskParameters;
790
+ }
791
+ /** Result from the personally identifiable information detection and redaction operation performed on a list of conversations. */
792
+ export interface AnalyzeConversationPIIResult extends AnalyzeConversationJobResult {
793
+ /** The result from PII detection and redaction operation for each conversation. */
794
+ kind: "conversationalPIIResults";
795
+ results: ConversationPIIResults;
796
+ }
797
+ /** Result for the summarization task on the conversation. */
798
+ export interface AnalyzeConversationSummarizationResult extends AnalyzeConversationJobResult {
799
+ kind: "conversationalSummarizationResults";
800
+ results: SummaryResult;
801
+ }
802
+ /** Supported parameters for a Conversational PII detection and redaction task. */
803
+ export interface ConversationPIITaskParameters extends PreBuiltTaskParameters {
804
+ /** Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language. */
805
+ piiCategories?: ConversationPIICategory[];
806
+ /** Flag to indicate if audio redaction is requested. By default audio redaction will not be performed. */
807
+ includeAudioRedaction?: boolean;
808
+ /** For transcript conversations, this parameter provides information regarding which content type (ITN, Text, Lexical, Masked ITN) should be used for entity detection. The details of the entities detected - like the offset, length and the text itself - will correspond to the text type selected here. */
809
+ redactionSource?: TranscriptContentType;
810
+ }
811
+ /** Supported parameters for an conversational summarization task. */
812
+ export interface ConversationSummarizationTaskParameters extends PreBuiltTaskParameters {
813
+ summaryAspects: SummaryAspect[];
814
+ }
815
+ /** Defines headers for ConversationAnalysisClient_analyzeConversation operation. */
816
+ export interface ConversationAnalysisClientAnalyzeConversationExceptionHeaders {
817
+ /** The error code for specific error that occurred. */
818
+ xMsErrorCode?: string;
819
+ }
820
+ /** Defines headers for ConversationAnalysisClient_conversationAnalysis operation. */
821
+ export interface ConversationAnalysisClientConversationAnalysisHeaders {
822
+ operationLocation?: string;
823
+ }
824
+ /** Known values of {@link AnalyzeConversationTaskKind} that the service accepts. */
825
+ export declare enum KnownAnalyzeConversationTaskKind {
826
+ /** Conversation */
827
+ Conversation = "Conversation"
828
+ }
829
+ /**
830
+ * Defines values for AnalyzeConversationTaskKind.
831
+ * {@link KnownAnalyzeConversationTaskKind} can be used interchangeably with AnalyzeConversationTaskKind,
832
+ * this enum contains the known values that the service supports.
833
+ * ### Known values supported by the service
834
+ * **Conversation**
835
+ */
836
+ export type AnalyzeConversationTaskKind = string;
837
+ /** Known values of {@link AnalyzeConversationTaskResultsKind} that the service accepts. */
838
+ export declare enum KnownAnalyzeConversationTaskResultsKind {
839
+ /** ConversationResult */
840
+ ConversationResult = "ConversationResult"
841
+ }
842
+ /**
843
+ * Defines values for AnalyzeConversationTaskResultsKind.
844
+ * {@link KnownAnalyzeConversationTaskResultsKind} can be used interchangeably with AnalyzeConversationTaskResultsKind,
845
+ * this enum contains the known values that the service supports.
846
+ * ### Known values supported by the service
847
+ * **ConversationResult**
848
+ */
849
+ export type AnalyzeConversationTaskResultsKind = string;
850
+ /** Known values of {@link ErrorCode} that the service accepts. */
851
+ export declare enum KnownErrorCode {
852
+ /** InvalidRequest */
853
+ InvalidRequest = "InvalidRequest",
854
+ /** InvalidArgument */
855
+ InvalidArgument = "InvalidArgument",
856
+ /** Unauthorized */
857
+ Unauthorized = "Unauthorized",
858
+ /** Forbidden */
859
+ Forbidden = "Forbidden",
860
+ /** NotFound */
861
+ NotFound = "NotFound",
862
+ /** ProjectNotFound */
863
+ ProjectNotFound = "ProjectNotFound",
864
+ /** OperationNotFound */
865
+ OperationNotFound = "OperationNotFound",
866
+ /** AzureCognitiveSearchNotFound */
867
+ AzureCognitiveSearchNotFound = "AzureCognitiveSearchNotFound",
868
+ /** AzureCognitiveSearchIndexNotFound */
869
+ AzureCognitiveSearchIndexNotFound = "AzureCognitiveSearchIndexNotFound",
870
+ /** TooManyRequests */
871
+ TooManyRequests = "TooManyRequests",
872
+ /** AzureCognitiveSearchThrottling */
873
+ AzureCognitiveSearchThrottling = "AzureCognitiveSearchThrottling",
874
+ /** AzureCognitiveSearchIndexLimitReached */
875
+ AzureCognitiveSearchIndexLimitReached = "AzureCognitiveSearchIndexLimitReached",
876
+ /** InternalServerError */
877
+ InternalServerError = "InternalServerError",
878
+ /** ServiceUnavailable */
879
+ ServiceUnavailable = "ServiceUnavailable",
880
+ /** Timeout */
881
+ Timeout = "Timeout",
882
+ /** QuotaExceeded */
883
+ QuotaExceeded = "QuotaExceeded",
884
+ /** Conflict */
885
+ Conflict = "Conflict",
886
+ /** Warning */
887
+ Warning = "Warning"
888
+ }
889
+ /**
890
+ * Defines values for ErrorCode.
891
+ * {@link KnownErrorCode} can be used interchangeably with ErrorCode,
892
+ * this enum contains the known values that the service supports.
893
+ * ### Known values supported by the service
894
+ * **InvalidRequest**
895
+ * **InvalidArgument**
896
+ * **Unauthorized**
897
+ * **Forbidden**
898
+ * **NotFound**
899
+ * **ProjectNotFound**
900
+ * **OperationNotFound**
901
+ * **AzureCognitiveSearchNotFound**
902
+ * **AzureCognitiveSearchIndexNotFound**
903
+ * **TooManyRequests**
904
+ * **AzureCognitiveSearchThrottling**
905
+ * **AzureCognitiveSearchIndexLimitReached**
906
+ * **InternalServerError**
907
+ * **ServiceUnavailable**
908
+ * **Timeout**
909
+ * **QuotaExceeded**
910
+ * **Conflict**
911
+ * **Warning**
912
+ */
913
+ export type ErrorCode = string;
914
+ /** Known values of {@link InnerErrorCode} that the service accepts. */
915
+ export declare enum KnownInnerErrorCode {
916
+ /** InvalidRequest */
917
+ InvalidRequest = "InvalidRequest",
918
+ /** InvalidParameterValue */
919
+ InvalidParameterValue = "InvalidParameterValue",
920
+ /** KnowledgeBaseNotFound */
921
+ KnowledgeBaseNotFound = "KnowledgeBaseNotFound",
922
+ /** AzureCognitiveSearchNotFound */
923
+ AzureCognitiveSearchNotFound = "AzureCognitiveSearchNotFound",
924
+ /** AzureCognitiveSearchThrottling */
925
+ AzureCognitiveSearchThrottling = "AzureCognitiveSearchThrottling",
926
+ /** ExtractionFailure */
927
+ ExtractionFailure = "ExtractionFailure",
928
+ /** InvalidRequestBodyFormat */
929
+ InvalidRequestBodyFormat = "InvalidRequestBodyFormat",
930
+ /** EmptyRequest */
931
+ EmptyRequest = "EmptyRequest",
932
+ /** MissingInputDocuments */
933
+ MissingInputDocuments = "MissingInputDocuments",
934
+ /** InvalidDocument */
935
+ InvalidDocument = "InvalidDocument",
936
+ /** ModelVersionIncorrect */
937
+ ModelVersionIncorrect = "ModelVersionIncorrect",
938
+ /** InvalidDocumentBatch */
939
+ InvalidDocumentBatch = "InvalidDocumentBatch",
940
+ /** UnsupportedLanguageCode */
941
+ UnsupportedLanguageCode = "UnsupportedLanguageCode",
942
+ /** InvalidCountryHint */
943
+ InvalidCountryHint = "InvalidCountryHint"
944
+ }
945
+ /**
946
+ * Defines values for InnerErrorCode.
947
+ * {@link KnownInnerErrorCode} can be used interchangeably with InnerErrorCode,
948
+ * this enum contains the known values that the service supports.
949
+ * ### Known values supported by the service
950
+ * **InvalidRequest**
951
+ * **InvalidParameterValue**
952
+ * **KnowledgeBaseNotFound**
953
+ * **AzureCognitiveSearchNotFound**
954
+ * **AzureCognitiveSearchThrottling**
955
+ * **ExtractionFailure**
956
+ * **InvalidRequestBodyFormat**
957
+ * **EmptyRequest**
958
+ * **MissingInputDocuments**
959
+ * **InvalidDocument**
960
+ * **ModelVersionIncorrect**
961
+ * **InvalidDocumentBatch**
962
+ * **UnsupportedLanguageCode**
963
+ * **InvalidCountryHint**
964
+ */
965
+ export type InnerErrorCode = string;
966
+ /** Known values of {@link InputModality} that the service accepts. */
967
+ export declare enum KnownInputModality {
968
+ /** Transcript */
969
+ Transcript = "transcript",
970
+ /** Text */
971
+ Text = "text"
972
+ }
973
+ /**
974
+ * Defines values for InputModality.
975
+ * {@link KnownInputModality} can be used interchangeably with InputModality,
976
+ * this enum contains the known values that the service supports.
977
+ * ### Known values supported by the service
978
+ * **transcript**
979
+ * **text**
980
+ */
981
+ export type InputModality = string;
982
+ /** Known values of {@link ConversationDomain} that the service accepts. */
983
+ export declare enum KnownConversationDomain {
984
+ /** Finance */
985
+ Finance = "finance",
986
+ /** Healthcare */
987
+ Healthcare = "healthcare",
988
+ /** Generic */
989
+ Generic = "generic"
990
+ }
991
+ /**
992
+ * Defines values for ConversationDomain.
993
+ * {@link KnownConversationDomain} can be used interchangeably with ConversationDomain,
994
+ * this enum contains the known values that the service supports.
995
+ * ### Known values supported by the service
996
+ * **finance**
997
+ * **healthcare**
998
+ * **generic**
999
+ */
1000
+ export type ConversationDomain = string;
1001
+ /** Known values of {@link AnalyzeConversationLROTaskKind} that the service accepts. */
1002
+ export declare enum KnownAnalyzeConversationLROTaskKind {
1003
+ /** ConversationalPIITask */
1004
+ ConversationalPIITask = "ConversationalPIITask",
1005
+ /** ConversationalSummarizationTask */
1006
+ ConversationalSummarizationTask = "ConversationalSummarizationTask"
1007
+ }
1008
+ /**
1009
+ * Defines values for AnalyzeConversationLROTaskKind.
1010
+ * {@link KnownAnalyzeConversationLROTaskKind} can be used interchangeably with AnalyzeConversationLROTaskKind,
1011
+ * this enum contains the known values that the service supports.
1012
+ * ### Known values supported by the service
1013
+ * **ConversationalPIITask**
1014
+ * **ConversationalSummarizationTask**
1015
+ */
1016
+ export type AnalyzeConversationLROTaskKind = string;
1017
+ /** Known values of {@link JobState} that the service accepts. */
1018
+ export declare enum KnownJobState {
1019
+ /** NotStarted */
1020
+ NotStarted = "notStarted",
1021
+ /** Running */
1022
+ Running = "running",
1023
+ /** Succeeded */
1024
+ Succeeded = "succeeded",
1025
+ /** PartiallyCompleted */
1026
+ PartiallyCompleted = "partiallyCompleted",
1027
+ /** Failed */
1028
+ Failed = "failed",
1029
+ /** Cancelled */
1030
+ Cancelled = "cancelled",
1031
+ /** Cancelling */
1032
+ Cancelling = "cancelling"
1033
+ }
1034
+ /**
1035
+ * Defines values for JobState.
1036
+ * {@link KnownJobState} can be used interchangeably with JobState,
1037
+ * this enum contains the known values that the service supports.
1038
+ * ### Known values supported by the service
1039
+ * **notStarted**
1040
+ * **running**
1041
+ * **succeeded**
1042
+ * **partiallyCompleted**
1043
+ * **failed**
1044
+ * **cancelled**
1045
+ * **cancelling**
1046
+ */
1047
+ export type JobState = string;
1048
+ /** Known values of {@link AnalyzeConversationResultsKind} that the service accepts. */
1049
+ export declare enum KnownAnalyzeConversationResultsKind {
1050
+ /** ConversationalPIIResults */
1051
+ ConversationalPIIResults = "ConversationalPIIResults",
1052
+ /** ConversationalSummarizationResults */
1053
+ ConversationalSummarizationResults = "ConversationalSummarizationResults"
1054
+ }
1055
+ /**
1056
+ * Defines values for AnalyzeConversationResultsKind.
1057
+ * {@link KnownAnalyzeConversationResultsKind} can be used interchangeably with AnalyzeConversationResultsKind,
1058
+ * this enum contains the known values that the service supports.
1059
+ * ### Known values supported by the service
1060
+ * **ConversationalPIIResults**
1061
+ * **ConversationalSummarizationResults**
1062
+ */
1063
+ export type AnalyzeConversationResultsKind = "conversationalPIIResults" | "conversationalSummarizationResults";
1064
+ /** Known values of {@link TaskState} that the service accepts. */
1065
+ export declare enum KnownTaskState {
1066
+ /** NotStarted */
1067
+ NotStarted = "notStarted",
1068
+ /** Running */
1069
+ Running = "running",
1070
+ /** Succeeded */
1071
+ Succeeded = "succeeded",
1072
+ /** Failed */
1073
+ Failed = "failed",
1074
+ /** Cancelled */
1075
+ Cancelled = "cancelled",
1076
+ /** Cancelling */
1077
+ Cancelling = "cancelling"
1078
+ }
1079
+ /**
1080
+ * Defines values for TaskState.
1081
+ * {@link KnownTaskState} can be used interchangeably with TaskState,
1082
+ * this enum contains the known values that the service supports.
1083
+ * ### Known values supported by the service
1084
+ * **notStarted**
1085
+ * **running**
1086
+ * **succeeded**
1087
+ * **failed**
1088
+ * **cancelled**
1089
+ * **cancelling**
1090
+ */
1091
+ export type TaskState = string;
1092
+ /** Known values of {@link Role} that the service accepts. */
1093
+ export declare enum KnownRole {
1094
+ /** Agent */
1095
+ Agent = "agent",
1096
+ /** Customer */
1097
+ Customer = "customer",
1098
+ /** Generic */
1099
+ Generic = "generic"
1100
+ }
1101
+ /**
1102
+ * Defines values for Role.
1103
+ * {@link KnownRole} can be used interchangeably with Role,
1104
+ * this enum contains the known values that the service supports.
1105
+ * ### Known values supported by the service
1106
+ * **agent**
1107
+ * **customer**
1108
+ * **generic**
1109
+ */
1110
+ export type Role = string;
1111
+ /** Known values of {@link StringIndexType} that the service accepts. */
1112
+ export declare enum KnownStringIndexType {
1113
+ /** 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. */
1114
+ TextElementsV8 = "TextElements_v8",
1115
+ /** 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. */
1116
+ UnicodeCodePoint = "UnicodeCodePoint",
1117
+ /** 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. */
1118
+ Utf16CodeUnit = "Utf16CodeUnit"
1119
+ }
1120
+ /**
1121
+ * Defines values for StringIndexType.
1122
+ * {@link KnownStringIndexType} can be used interchangeably with StringIndexType,
1123
+ * this enum contains the known values that the service supports.
1124
+ * ### Known values supported by the service
1125
+ * **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.
1126
+ * **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.
1127
+ * **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.
1128
+ */
1129
+ export type StringIndexType = string;
1130
+ /** Known values of {@link TargetProjectKind} that the service accepts. */
1131
+ export declare enum KnownTargetProjectKind {
1132
+ /** Luis */
1133
+ Luis = "Luis",
1134
+ /** Conversation */
1135
+ Conversation = "Conversation",
1136
+ /** QuestionAnswering */
1137
+ QuestionAnswering = "QuestionAnswering",
1138
+ /** NonLinked */
1139
+ NonLinked = "NonLinked"
1140
+ }
1141
+ /**
1142
+ * Defines values for TargetProjectKind.
1143
+ * {@link KnownTargetProjectKind} can be used interchangeably with TargetProjectKind,
1144
+ * this enum contains the known values that the service supports.
1145
+ * ### Known values supported by the service
1146
+ * **Luis**
1147
+ * **Conversation**
1148
+ * **QuestionAnswering**
1149
+ * **NonLinked**
1150
+ */
1151
+ export type TargetProjectKind = string;
1152
+ /** Known values of {@link ProjectKind} that the service accepts. */
1153
+ export declare enum KnownProjectKind {
1154
+ /** Conversation */
1155
+ Conversation = "Conversation",
1156
+ /** Orchestration */
1157
+ Orchestration = "Orchestration"
1158
+ }
1159
+ /**
1160
+ * Defines values for ProjectKind.
1161
+ * {@link KnownProjectKind} can be used interchangeably with ProjectKind,
1162
+ * this enum contains the known values that the service supports.
1163
+ * ### Known values supported by the service
1164
+ * **Conversation**
1165
+ * **Orchestration**
1166
+ */
1167
+ export type ProjectKind = string;
1168
+ /** Known values of {@link ResolutionKind} that the service accepts. */
1169
+ export declare enum KnownResolutionKind {
1170
+ /** Boolean */
1171
+ Boolean = "Boolean",
1172
+ /** DateTime */
1173
+ DateTime = "DateTime",
1174
+ /** Number */
1175
+ Number = "Number",
1176
+ /** Ordinal */
1177
+ Ordinal = "Ordinal",
1178
+ /** Speed */
1179
+ Speed = "Speed",
1180
+ /** Weight */
1181
+ Weight = "Weight",
1182
+ /** Length */
1183
+ Length = "Length",
1184
+ /** Volume */
1185
+ Volume = "Volume",
1186
+ /** Area */
1187
+ Area = "Area",
1188
+ /** Age */
1189
+ Age = "Age",
1190
+ /** Information */
1191
+ Information = "Information",
1192
+ /** Temperature */
1193
+ Temperature = "Temperature",
1194
+ /** Currency */
1195
+ Currency = "Currency",
1196
+ /** NumericRange */
1197
+ NumericRange = "NumericRange",
1198
+ /** TemporalSpan */
1199
+ TemporalSpan = "TemporalSpan"
1200
+ }
1201
+ /**
1202
+ * Defines values for ResolutionKind.
1203
+ * {@link KnownResolutionKind} can be used interchangeably with ResolutionKind,
1204
+ * this enum contains the known values that the service supports.
1205
+ * ### Known values supported by the service
1206
+ * **Boolean**
1207
+ * **DateTime**
1208
+ * **Number**
1209
+ * **Ordinal**
1210
+ * **Speed**
1211
+ * **Weight**
1212
+ * **Length**
1213
+ * **Volume**
1214
+ * **Area**
1215
+ * **Age**
1216
+ * **Information**
1217
+ * **Temperature**
1218
+ * **Currency**
1219
+ * **NumericRange**
1220
+ * **TemporalSpan**
1221
+ */
1222
+ export type ResolutionKind = string;
1223
+ /** Known values of {@link ExtraInformationKind} that the service accepts. */
1224
+ export declare enum KnownExtraInformationKind {
1225
+ /** EntitySubtype */
1226
+ EntitySubtype = "EntitySubtype",
1227
+ /** ListKey */
1228
+ ListKey = "ListKey"
1229
+ }
1230
+ /**
1231
+ * Defines values for ExtraInformationKind.
1232
+ * {@link KnownExtraInformationKind} can be used interchangeably with ExtraInformationKind,
1233
+ * this enum contains the known values that the service supports.
1234
+ * ### Known values supported by the service
1235
+ * **EntitySubtype**
1236
+ * **ListKey**
1237
+ */
1238
+ export type ExtraInformationKind = string;
1239
+ /** Known values of {@link RankerKind} that the service accepts. */
1240
+ export declare enum KnownRankerKind {
1241
+ /** Question only ranker. */
1242
+ QuestionOnly = "QuestionOnly",
1243
+ /** Default ranker. */
1244
+ Default = "Default"
1245
+ }
1246
+ /**
1247
+ * Defines values for RankerKind.
1248
+ * {@link KnownRankerKind} can be used interchangeably with RankerKind,
1249
+ * this enum contains the known values that the service supports.
1250
+ * ### Known values supported by the service
1251
+ * **QuestionOnly**: Question only ranker.
1252
+ * **Default**: Default ranker.
1253
+ */
1254
+ export type RankerKind = string;
1255
+ /** Known values of {@link LogicalOperationKind} that the service accepts. */
1256
+ export declare enum KnownLogicalOperationKind {
1257
+ /** AND */
1258
+ AND = "AND",
1259
+ /** OR */
1260
+ OR = "OR"
1261
+ }
1262
+ /**
1263
+ * Defines values for LogicalOperationKind.
1264
+ * {@link KnownLogicalOperationKind} can be used interchangeably with LogicalOperationKind,
1265
+ * this enum contains the known values that the service supports.
1266
+ * ### Known values supported by the service
1267
+ * **AND**
1268
+ * **OR**
1269
+ */
1270
+ export type LogicalOperationKind = string;
1271
+ /** Known values of {@link AgeUnit} that the service accepts. */
1272
+ export declare enum KnownAgeUnit {
1273
+ /** Unspecified */
1274
+ Unspecified = "Unspecified",
1275
+ /** Year */
1276
+ Year = "Year",
1277
+ /** Month */
1278
+ Month = "Month",
1279
+ /** Week */
1280
+ Week = "Week",
1281
+ /** Day */
1282
+ Day = "Day"
1283
+ }
1284
+ /**
1285
+ * Defines values for AgeUnit.
1286
+ * {@link KnownAgeUnit} can be used interchangeably with AgeUnit,
1287
+ * this enum contains the known values that the service supports.
1288
+ * ### Known values supported by the service
1289
+ * **Unspecified**
1290
+ * **Year**
1291
+ * **Month**
1292
+ * **Week**
1293
+ * **Day**
1294
+ */
1295
+ export type AgeUnit = string;
1296
+ /** Known values of {@link VolumeUnit} that the service accepts. */
1297
+ export declare enum KnownVolumeUnit {
1298
+ /** Unspecified */
1299
+ Unspecified = "Unspecified",
1300
+ /** CubicMeter */
1301
+ CubicMeter = "CubicMeter",
1302
+ /** CubicCentimeter */
1303
+ CubicCentimeter = "CubicCentimeter",
1304
+ /** CubicMillimeter */
1305
+ CubicMillimeter = "CubicMillimeter",
1306
+ /** Hectoliter */
1307
+ Hectoliter = "Hectoliter",
1308
+ /** Decaliter */
1309
+ Decaliter = "Decaliter",
1310
+ /** Liter */
1311
+ Liter = "Liter",
1312
+ /** Centiliter */
1313
+ Centiliter = "Centiliter",
1314
+ /** Milliliter */
1315
+ Milliliter = "Milliliter",
1316
+ /** CubicYard */
1317
+ CubicYard = "CubicYard",
1318
+ /** CubicInch */
1319
+ CubicInch = "CubicInch",
1320
+ /** CubicFoot */
1321
+ CubicFoot = "CubicFoot",
1322
+ /** CubicMile */
1323
+ CubicMile = "CubicMile",
1324
+ /** FluidOunce */
1325
+ FluidOunce = "FluidOunce",
1326
+ /** Teaspoon */
1327
+ Teaspoon = "Teaspoon",
1328
+ /** Tablespoon */
1329
+ Tablespoon = "Tablespoon",
1330
+ /** Pint */
1331
+ Pint = "Pint",
1332
+ /** Quart */
1333
+ Quart = "Quart",
1334
+ /** Cup */
1335
+ Cup = "Cup",
1336
+ /** Gill */
1337
+ Gill = "Gill",
1338
+ /** Pinch */
1339
+ Pinch = "Pinch",
1340
+ /** FluidDram */
1341
+ FluidDram = "FluidDram",
1342
+ /** Barrel */
1343
+ Barrel = "Barrel",
1344
+ /** Minim */
1345
+ Minim = "Minim",
1346
+ /** Cord */
1347
+ Cord = "Cord",
1348
+ /** Peck */
1349
+ Peck = "Peck",
1350
+ /** Bushel */
1351
+ Bushel = "Bushel",
1352
+ /** Hogshead */
1353
+ Hogshead = "Hogshead"
1354
+ }
1355
+ /**
1356
+ * Defines values for VolumeUnit.
1357
+ * {@link KnownVolumeUnit} can be used interchangeably with VolumeUnit,
1358
+ * this enum contains the known values that the service supports.
1359
+ * ### Known values supported by the service
1360
+ * **Unspecified**
1361
+ * **CubicMeter**
1362
+ * **CubicCentimeter**
1363
+ * **CubicMillimeter**
1364
+ * **Hectoliter**
1365
+ * **Decaliter**
1366
+ * **Liter**
1367
+ * **Centiliter**
1368
+ * **Milliliter**
1369
+ * **CubicYard**
1370
+ * **CubicInch**
1371
+ * **CubicFoot**
1372
+ * **CubicMile**
1373
+ * **FluidOunce**
1374
+ * **Teaspoon**
1375
+ * **Tablespoon**
1376
+ * **Pint**
1377
+ * **Quart**
1378
+ * **Cup**
1379
+ * **Gill**
1380
+ * **Pinch**
1381
+ * **FluidDram**
1382
+ * **Barrel**
1383
+ * **Minim**
1384
+ * **Cord**
1385
+ * **Peck**
1386
+ * **Bushel**
1387
+ * **Hogshead**
1388
+ */
1389
+ export type VolumeUnit = string;
1390
+ /** Known values of {@link SpeedUnit} that the service accepts. */
1391
+ export declare enum KnownSpeedUnit {
1392
+ /** Unspecified */
1393
+ Unspecified = "Unspecified",
1394
+ /** MetersPerSecond */
1395
+ MetersPerSecond = "MetersPerSecond",
1396
+ /** KilometersPerHour */
1397
+ KilometersPerHour = "KilometersPerHour",
1398
+ /** KilometersPerMinute */
1399
+ KilometersPerMinute = "KilometersPerMinute",
1400
+ /** KilometersPerSecond */
1401
+ KilometersPerSecond = "KilometersPerSecond",
1402
+ /** MilesPerHour */
1403
+ MilesPerHour = "MilesPerHour",
1404
+ /** Knot */
1405
+ Knot = "Knot",
1406
+ /** FootPerSecond */
1407
+ FootPerSecond = "FootPerSecond",
1408
+ /** FootPerMinute */
1409
+ FootPerMinute = "FootPerMinute",
1410
+ /** YardsPerMinute */
1411
+ YardsPerMinute = "YardsPerMinute",
1412
+ /** YardsPerSecond */
1413
+ YardsPerSecond = "YardsPerSecond",
1414
+ /** MetersPerMillisecond */
1415
+ MetersPerMillisecond = "MetersPerMillisecond",
1416
+ /** CentimetersPerMillisecond */
1417
+ CentimetersPerMillisecond = "CentimetersPerMillisecond",
1418
+ /** KilometersPerMillisecond */
1419
+ KilometersPerMillisecond = "KilometersPerMillisecond"
1420
+ }
1421
+ /**
1422
+ * Defines values for SpeedUnit.
1423
+ * {@link KnownSpeedUnit} can be used interchangeably with SpeedUnit,
1424
+ * this enum contains the known values that the service supports.
1425
+ * ### Known values supported by the service
1426
+ * **Unspecified**
1427
+ * **MetersPerSecond**
1428
+ * **KilometersPerHour**
1429
+ * **KilometersPerMinute**
1430
+ * **KilometersPerSecond**
1431
+ * **MilesPerHour**
1432
+ * **Knot**
1433
+ * **FootPerSecond**
1434
+ * **FootPerMinute**
1435
+ * **YardsPerMinute**
1436
+ * **YardsPerSecond**
1437
+ * **MetersPerMillisecond**
1438
+ * **CentimetersPerMillisecond**
1439
+ * **KilometersPerMillisecond**
1440
+ */
1441
+ export type SpeedUnit = string;
1442
+ /** Known values of {@link AreaUnit} that the service accepts. */
1443
+ export declare enum KnownAreaUnit {
1444
+ /** Unspecified */
1445
+ Unspecified = "Unspecified",
1446
+ /** SquareKilometer */
1447
+ SquareKilometer = "SquareKilometer",
1448
+ /** SquareHectometer */
1449
+ SquareHectometer = "SquareHectometer",
1450
+ /** SquareDecameter */
1451
+ SquareDecameter = "SquareDecameter",
1452
+ /** SquareDecimeter */
1453
+ SquareDecimeter = "SquareDecimeter",
1454
+ /** SquareMeter */
1455
+ SquareMeter = "SquareMeter",
1456
+ /** SquareCentimeter */
1457
+ SquareCentimeter = "SquareCentimeter",
1458
+ /** SquareMillimeter */
1459
+ SquareMillimeter = "SquareMillimeter",
1460
+ /** SquareInch */
1461
+ SquareInch = "SquareInch",
1462
+ /** SquareFoot */
1463
+ SquareFoot = "SquareFoot",
1464
+ /** SquareMile */
1465
+ SquareMile = "SquareMile",
1466
+ /** SquareYard */
1467
+ SquareYard = "SquareYard",
1468
+ /** Acre */
1469
+ Acre = "Acre"
1470
+ }
1471
+ /**
1472
+ * Defines values for AreaUnit.
1473
+ * {@link KnownAreaUnit} can be used interchangeably with AreaUnit,
1474
+ * this enum contains the known values that the service supports.
1475
+ * ### Known values supported by the service
1476
+ * **Unspecified**
1477
+ * **SquareKilometer**
1478
+ * **SquareHectometer**
1479
+ * **SquareDecameter**
1480
+ * **SquareDecimeter**
1481
+ * **SquareMeter**
1482
+ * **SquareCentimeter**
1483
+ * **SquareMillimeter**
1484
+ * **SquareInch**
1485
+ * **SquareFoot**
1486
+ * **SquareMile**
1487
+ * **SquareYard**
1488
+ * **Acre**
1489
+ */
1490
+ export type AreaUnit = string;
1491
+ /** Known values of {@link LengthUnit} that the service accepts. */
1492
+ export declare enum KnownLengthUnit {
1493
+ /** Unspecified */
1494
+ Unspecified = "Unspecified",
1495
+ /** Kilometer */
1496
+ Kilometer = "Kilometer",
1497
+ /** Hectometer */
1498
+ Hectometer = "Hectometer",
1499
+ /** Decameter */
1500
+ Decameter = "Decameter",
1501
+ /** Meter */
1502
+ Meter = "Meter",
1503
+ /** Decimeter */
1504
+ Decimeter = "Decimeter",
1505
+ /** Centimeter */
1506
+ Centimeter = "Centimeter",
1507
+ /** Millimeter */
1508
+ Millimeter = "Millimeter",
1509
+ /** Micrometer */
1510
+ Micrometer = "Micrometer",
1511
+ /** Nanometer */
1512
+ Nanometer = "Nanometer",
1513
+ /** Picometer */
1514
+ Picometer = "Picometer",
1515
+ /** Mile */
1516
+ Mile = "Mile",
1517
+ /** Yard */
1518
+ Yard = "Yard",
1519
+ /** Inch */
1520
+ Inch = "Inch",
1521
+ /** Foot */
1522
+ Foot = "Foot",
1523
+ /** LightYear */
1524
+ LightYear = "LightYear",
1525
+ /** Pt */
1526
+ Pt = "Pt"
1527
+ }
1528
+ /**
1529
+ * Defines values for LengthUnit.
1530
+ * {@link KnownLengthUnit} can be used interchangeably with LengthUnit,
1531
+ * this enum contains the known values that the service supports.
1532
+ * ### Known values supported by the service
1533
+ * **Unspecified**
1534
+ * **Kilometer**
1535
+ * **Hectometer**
1536
+ * **Decameter**
1537
+ * **Meter**
1538
+ * **Decimeter**
1539
+ * **Centimeter**
1540
+ * **Millimeter**
1541
+ * **Micrometer**
1542
+ * **Nanometer**
1543
+ * **Picometer**
1544
+ * **Mile**
1545
+ * **Yard**
1546
+ * **Inch**
1547
+ * **Foot**
1548
+ * **LightYear**
1549
+ * **Pt**
1550
+ */
1551
+ export type LengthUnit = string;
1552
+ /** Known values of {@link InformationUnit} that the service accepts. */
1553
+ export declare enum KnownInformationUnit {
1554
+ /** Unspecified */
1555
+ Unspecified = "Unspecified",
1556
+ /** Bit */
1557
+ Bit = "Bit",
1558
+ /** Kilobit */
1559
+ Kilobit = "Kilobit",
1560
+ /** Megabit */
1561
+ Megabit = "Megabit",
1562
+ /** Gigabit */
1563
+ Gigabit = "Gigabit",
1564
+ /** Terabit */
1565
+ Terabit = "Terabit",
1566
+ /** Petabit */
1567
+ Petabit = "Petabit",
1568
+ /** Byte */
1569
+ Byte = "Byte",
1570
+ /** Kilobyte */
1571
+ Kilobyte = "Kilobyte",
1572
+ /** Megabyte */
1573
+ Megabyte = "Megabyte",
1574
+ /** Gigabyte */
1575
+ Gigabyte = "Gigabyte",
1576
+ /** Terabyte */
1577
+ Terabyte = "Terabyte",
1578
+ /** Petabyte */
1579
+ Petabyte = "Petabyte"
1580
+ }
1581
+ /**
1582
+ * Defines values for InformationUnit.
1583
+ * {@link KnownInformationUnit} can be used interchangeably with InformationUnit,
1584
+ * this enum contains the known values that the service supports.
1585
+ * ### Known values supported by the service
1586
+ * **Unspecified**
1587
+ * **Bit**
1588
+ * **Kilobit**
1589
+ * **Megabit**
1590
+ * **Gigabit**
1591
+ * **Terabit**
1592
+ * **Petabit**
1593
+ * **Byte**
1594
+ * **Kilobyte**
1595
+ * **Megabyte**
1596
+ * **Gigabyte**
1597
+ * **Terabyte**
1598
+ * **Petabyte**
1599
+ */
1600
+ export type InformationUnit = string;
1601
+ /** Known values of {@link TemperatureUnit} that the service accepts. */
1602
+ export declare enum KnownTemperatureUnit {
1603
+ /** Unspecified */
1604
+ Unspecified = "Unspecified",
1605
+ /** Fahrenheit */
1606
+ Fahrenheit = "Fahrenheit",
1607
+ /** Kelvin */
1608
+ Kelvin = "Kelvin",
1609
+ /** Rankine */
1610
+ Rankine = "Rankine",
1611
+ /** Celsius */
1612
+ Celsius = "Celsius"
1613
+ }
1614
+ /**
1615
+ * Defines values for TemperatureUnit.
1616
+ * {@link KnownTemperatureUnit} can be used interchangeably with TemperatureUnit,
1617
+ * this enum contains the known values that the service supports.
1618
+ * ### Known values supported by the service
1619
+ * **Unspecified**
1620
+ * **Fahrenheit**
1621
+ * **Kelvin**
1622
+ * **Rankine**
1623
+ * **Celsius**
1624
+ */
1625
+ export type TemperatureUnit = string;
1626
+ /** Known values of {@link WeightUnit} that the service accepts. */
1627
+ export declare enum KnownWeightUnit {
1628
+ /** Unspecified */
1629
+ Unspecified = "Unspecified",
1630
+ /** Kilogram */
1631
+ Kilogram = "Kilogram",
1632
+ /** Gram */
1633
+ Gram = "Gram",
1634
+ /** Milligram */
1635
+ Milligram = "Milligram",
1636
+ /** Gallon */
1637
+ Gallon = "Gallon",
1638
+ /** MetricTon */
1639
+ MetricTon = "MetricTon",
1640
+ /** Ton */
1641
+ Ton = "Ton",
1642
+ /** Pound */
1643
+ Pound = "Pound",
1644
+ /** Ounce */
1645
+ Ounce = "Ounce",
1646
+ /** Grain */
1647
+ Grain = "Grain",
1648
+ /** PennyWeight */
1649
+ PennyWeight = "PennyWeight",
1650
+ /** LongTonBritish */
1651
+ LongTonBritish = "LongTonBritish",
1652
+ /** ShortTonUS */
1653
+ ShortTonUS = "ShortTonUS",
1654
+ /** ShortHundredWeightUS */
1655
+ ShortHundredWeightUS = "ShortHundredWeightUS",
1656
+ /** Stone */
1657
+ Stone = "Stone",
1658
+ /** Dram */
1659
+ Dram = "Dram"
1660
+ }
1661
+ /**
1662
+ * Defines values for WeightUnit.
1663
+ * {@link KnownWeightUnit} can be used interchangeably with WeightUnit,
1664
+ * this enum contains the known values that the service supports.
1665
+ * ### Known values supported by the service
1666
+ * **Unspecified**
1667
+ * **Kilogram**
1668
+ * **Gram**
1669
+ * **Milligram**
1670
+ * **Gallon**
1671
+ * **MetricTon**
1672
+ * **Ton**
1673
+ * **Pound**
1674
+ * **Ounce**
1675
+ * **Grain**
1676
+ * **PennyWeight**
1677
+ * **LongTonBritish**
1678
+ * **ShortTonUS**
1679
+ * **ShortHundredWeightUS**
1680
+ * **Stone**
1681
+ * **Dram**
1682
+ */
1683
+ export type WeightUnit = string;
1684
+ /** Known values of {@link DateTimeSubKind} that the service accepts. */
1685
+ export declare enum KnownDateTimeSubKind {
1686
+ /** Time */
1687
+ Time = "Time",
1688
+ /** Date */
1689
+ Date = "Date",
1690
+ /** DateTime */
1691
+ DateTime = "DateTime",
1692
+ /** Duration */
1693
+ Duration = "Duration",
1694
+ /** Set */
1695
+ Set = "Set"
1696
+ }
1697
+ /**
1698
+ * Defines values for DateTimeSubKind.
1699
+ * {@link KnownDateTimeSubKind} can be used interchangeably with DateTimeSubKind,
1700
+ * this enum contains the known values that the service supports.
1701
+ * ### Known values supported by the service
1702
+ * **Time**
1703
+ * **Date**
1704
+ * **DateTime**
1705
+ * **Duration**
1706
+ * **Set**
1707
+ */
1708
+ export type DateTimeSubKind = string;
1709
+ /** Known values of {@link TemporalModifier} that the service accepts. */
1710
+ export declare enum KnownTemporalModifier {
1711
+ /** AfterApprox */
1712
+ AfterApprox = "AfterApprox",
1713
+ /** Before */
1714
+ Before = "Before",
1715
+ /** BeforeStart */
1716
+ BeforeStart = "BeforeStart",
1717
+ /** Approx */
1718
+ Approx = "Approx",
1719
+ /** ReferenceUndefined */
1720
+ ReferenceUndefined = "ReferenceUndefined",
1721
+ /** SinceEnd */
1722
+ SinceEnd = "SinceEnd",
1723
+ /** AfterMid */
1724
+ AfterMid = "AfterMid",
1725
+ /** Start */
1726
+ Start = "Start",
1727
+ /** After */
1728
+ After = "After",
1729
+ /** BeforeEnd */
1730
+ BeforeEnd = "BeforeEnd",
1731
+ /** Until */
1732
+ Until = "Until",
1733
+ /** End */
1734
+ End = "End",
1735
+ /** Less */
1736
+ Less = "Less",
1737
+ /** Since */
1738
+ Since = "Since",
1739
+ /** AfterStart */
1740
+ AfterStart = "AfterStart",
1741
+ /** BeforeApprox */
1742
+ BeforeApprox = "BeforeApprox",
1743
+ /** Mid */
1744
+ Mid = "Mid",
1745
+ /** More */
1746
+ More = "More"
1747
+ }
1748
+ /**
1749
+ * Defines values for TemporalModifier.
1750
+ * {@link KnownTemporalModifier} can be used interchangeably with TemporalModifier,
1751
+ * this enum contains the known values that the service supports.
1752
+ * ### Known values supported by the service
1753
+ * **AfterApprox**
1754
+ * **Before**
1755
+ * **BeforeStart**
1756
+ * **Approx**
1757
+ * **ReferenceUndefined**
1758
+ * **SinceEnd**
1759
+ * **AfterMid**
1760
+ * **Start**
1761
+ * **After**
1762
+ * **BeforeEnd**
1763
+ * **Until**
1764
+ * **End**
1765
+ * **Less**
1766
+ * **Since**
1767
+ * **AfterStart**
1768
+ * **BeforeApprox**
1769
+ * **Mid**
1770
+ * **More**
1771
+ */
1772
+ export type TemporalModifier = string;
1773
+ /** Known values of {@link NumberKind} that the service accepts. */
1774
+ export declare enum KnownNumberKind {
1775
+ /** Integer */
1776
+ Integer = "Integer",
1777
+ /** Decimal */
1778
+ Decimal = "Decimal",
1779
+ /** Power */
1780
+ Power = "Power",
1781
+ /** Fraction */
1782
+ Fraction = "Fraction",
1783
+ /** Percent */
1784
+ Percent = "Percent",
1785
+ /** Unspecified */
1786
+ Unspecified = "Unspecified"
1787
+ }
1788
+ /**
1789
+ * Defines values for NumberKind.
1790
+ * {@link KnownNumberKind} can be used interchangeably with NumberKind,
1791
+ * this enum contains the known values that the service supports.
1792
+ * ### Known values supported by the service
1793
+ * **Integer**
1794
+ * **Decimal**
1795
+ * **Power**
1796
+ * **Fraction**
1797
+ * **Percent**
1798
+ * **Unspecified**
1799
+ */
1800
+ export type NumberKind = string;
1801
+ /** Known values of {@link RelativeTo} that the service accepts. */
1802
+ export declare enum KnownRelativeTo {
1803
+ /** Current */
1804
+ Current = "Current",
1805
+ /** End */
1806
+ End = "End",
1807
+ /** Start */
1808
+ Start = "Start"
1809
+ }
1810
+ /**
1811
+ * Defines values for RelativeTo.
1812
+ * {@link KnownRelativeTo} can be used interchangeably with RelativeTo,
1813
+ * this enum contains the known values that the service supports.
1814
+ * ### Known values supported by the service
1815
+ * **Current**
1816
+ * **End**
1817
+ * **Start**
1818
+ */
1819
+ export type RelativeTo = string;
1820
+ /** Known values of {@link RangeKind} that the service accepts. */
1821
+ export declare enum KnownRangeKind {
1822
+ /** Number */
1823
+ Number = "Number",
1824
+ /** Speed */
1825
+ Speed = "Speed",
1826
+ /** Weight */
1827
+ Weight = "Weight",
1828
+ /** Length */
1829
+ Length = "Length",
1830
+ /** Volume */
1831
+ Volume = "Volume",
1832
+ /** Area */
1833
+ Area = "Area",
1834
+ /** Age */
1835
+ Age = "Age",
1836
+ /** Information */
1837
+ Information = "Information",
1838
+ /** Temperature */
1839
+ Temperature = "Temperature",
1840
+ /** Currency */
1841
+ Currency = "Currency"
1842
+ }
1843
+ /**
1844
+ * Defines values for RangeKind.
1845
+ * {@link KnownRangeKind} can be used interchangeably with RangeKind,
1846
+ * this enum contains the known values that the service supports.
1847
+ * ### Known values supported by the service
1848
+ * **Number**
1849
+ * **Speed**
1850
+ * **Weight**
1851
+ * **Length**
1852
+ * **Volume**
1853
+ * **Area**
1854
+ * **Age**
1855
+ * **Information**
1856
+ * **Temperature**
1857
+ * **Currency**
1858
+ */
1859
+ export type RangeKind = string;
1860
+ /** Known values of {@link ConversationPIICategory} that the service accepts. */
1861
+ export declare enum KnownConversationPIICategory {
1862
+ /** Address */
1863
+ Address = "Address",
1864
+ /** CreditCard */
1865
+ CreditCard = "CreditCard",
1866
+ /** Email */
1867
+ Email = "Email",
1868
+ /** Name */
1869
+ Name = "Name",
1870
+ /** NumericIdentifier */
1871
+ NumericIdentifier = "NumericIdentifier",
1872
+ /** PhoneNumber */
1873
+ PhoneNumber = "PhoneNumber",
1874
+ /** All */
1875
+ All = "All",
1876
+ /** Default */
1877
+ Default = "Default"
1878
+ }
1879
+ /**
1880
+ * Defines values for ConversationPIICategory.
1881
+ * {@link KnownConversationPIICategory} can be used interchangeably with ConversationPIICategory,
1882
+ * this enum contains the known values that the service supports.
1883
+ * ### Known values supported by the service
1884
+ * **Address**
1885
+ * **CreditCard**
1886
+ * **Email**
1887
+ * **Name**
1888
+ * **NumericIdentifier**
1889
+ * **PhoneNumber**
1890
+ * **All**
1891
+ * **Default**
1892
+ */
1893
+ export type ConversationPIICategory = string;
1894
+ /** Known values of {@link TranscriptContentType} that the service accepts. */
1895
+ export declare enum KnownTranscriptContentType {
1896
+ /** Lexical */
1897
+ Lexical = "lexical",
1898
+ /** Itn */
1899
+ Itn = "itn",
1900
+ /** MaskedItn */
1901
+ MaskedItn = "maskedItn",
1902
+ /** Text */
1903
+ Text = "text"
1904
+ }
1905
+ /**
1906
+ * Defines values for TranscriptContentType.
1907
+ * {@link KnownTranscriptContentType} can be used interchangeably with TranscriptContentType,
1908
+ * this enum contains the known values that the service supports.
1909
+ * ### Known values supported by the service
1910
+ * **lexical**
1911
+ * **itn**
1912
+ * **maskedItn**
1913
+ * **text**
1914
+ */
1915
+ export type TranscriptContentType = string;
1916
+ /** Known values of {@link SummaryAspect} that the service accepts. */
1917
+ export declare enum KnownSummaryAspect {
1918
+ /** Issue */
1919
+ Issue = "issue",
1920
+ /** Resolution */
1921
+ Resolution = "resolution"
1922
+ }
1923
+ /**
1924
+ * Defines values for SummaryAspect.
1925
+ * {@link KnownSummaryAspect} can be used interchangeably with SummaryAspect,
1926
+ * this enum contains the known values that the service supports.
1927
+ * ### Known values supported by the service
1928
+ * **issue**
1929
+ * **resolution**
1930
+ */
1931
+ export type SummaryAspect = string;
1932
+ /** Optional parameters. */
1933
+ export interface AnalyzeConversationOptionalParams extends coreClient.OperationOptions {
1934
+ }
1935
+ /** Contains response data for the analyzeConversation operation. */
1936
+ export type AnalyzeConversationResponse = AnalyzeConversationTaskResultUnion;
1937
+ /** Optional parameters. */
1938
+ export interface ConversationAnalysisOptionalParams extends coreClient.OperationOptions {
1939
+ /** Delay to wait until next poll, in milliseconds. */
1940
+ updateIntervalInMs?: number;
1941
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
1942
+ resumeFrom?: string;
1943
+ }
1944
+ /** Contains response data for the conversationAnalysis operation. */
1945
+ export type ConversationAnalysisResponse = AnalyzeConversationJobState;
1946
+ /** Optional parameters. */
1947
+ export interface ConversationAnalysisClientOptionalParams extends coreClient.ServiceClientOptions {
1948
+ /** Api Version */
1949
+ apiVersion?: string;
1950
+ /** Overrides client endpoint. */
1951
+ endpoint?: string;
1952
+ }
1953
+ //# sourceMappingURL=models.d.ts.map