@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
@@ -1,1291 +0,0 @@
1
- ## API Report File for "@azure/ai-language-conversations"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { AzureKeyCredential } from '@azure/core-auth';
8
- import * as coreClient from '@azure/core-client';
9
- import { KeyCredential } from '@azure/core-auth';
10
- import { PollerLike } from '@azure/core-lro';
11
- import { PollOperationState } from '@azure/core-lro';
12
- import { TokenCredential } from '@azure/core-auth';
13
-
14
- // @public
15
- export interface AgeResolution extends BaseResolution, QuantityResolution {
16
- resolutionKind: "Age";
17
- unit: AgeUnit;
18
- }
19
-
20
- // @public
21
- export type AgeUnit = string;
22
-
23
- // @public
24
- export interface AnalysisParameters {
25
- apiVersion?: string;
26
- targetProjectKind: "Luis" | "Conversation" | "QuestionAnswering";
27
- }
28
-
29
- // @public (undocumented)
30
- export type AnalysisParametersUnion = LuisParameters | ConversationParameters | QuestionAnsweringParameters;
31
-
32
- // @public
33
- export interface AnalyzeConversationJobResult extends TaskStateAutoGenerated, TaskIdentifier {
34
- kind: AnalyzeConversationResultsKind;
35
- }
36
-
37
- // @public (undocumented)
38
- export type AnalyzeConversationJobResultUnion = AnalyzeConversationPIIResult | AnalyzeConversationSummarizationResult;
39
-
40
- // @public (undocumented)
41
- export interface AnalyzeConversationJobsInput {
42
- // (undocumented)
43
- analysisInput: MultiLanguageConversationAnalysisInput;
44
- displayName?: string;
45
- tasks: AnalyzeConversationLROTaskUnion[];
46
- }
47
-
48
- // @public
49
- export interface AnalyzeConversationJobState extends JobStateAutoGenerated, ConversationTasksState, AnalyzeConversationJobStatistics {
50
- }
51
-
52
- // @public
53
- export interface AnalyzeConversationJobStatistics {
54
- statistics?: ConversationRequestStatistics;
55
- }
56
-
57
- // @public
58
- export interface AnalyzeConversationLROTask extends TaskIdentifier {
59
- kind: AnalyzeConversationLROTaskKind;
60
- }
61
-
62
- // @public
63
- export type AnalyzeConversationLROTaskKind = string;
64
-
65
- // @public (undocumented)
66
- export type AnalyzeConversationLROTaskUnion = AnalyzeConversationPIITask | AnalyzeConversationSummarizationTask;
67
-
68
- // @public
69
- export interface AnalyzeConversationOptionalParams extends coreClient.OperationOptions {
70
- }
71
-
72
- // @public
73
- export interface AnalyzeConversationPIIResult extends AnalyzeConversationJobResult {
74
- kind: "conversationalPIIResults";
75
- // (undocumented)
76
- results: ConversationPIIResults;
77
- }
78
-
79
- // @public
80
- export interface AnalyzeConversationPIITask extends AnalyzeConversationLROTask {
81
- parameters?: ConversationPIITaskParameters;
82
- }
83
-
84
- // @public
85
- export type AnalyzeConversationResponse = AnalyzeConversationTaskResultUnion;
86
-
87
- // @public
88
- export interface AnalyzeConversationResult {
89
- detectedLanguage?: string;
90
- prediction: BasePredictionUnion;
91
- query: string;
92
- }
93
-
94
- // @public
95
- export type AnalyzeConversationResultsKind = "conversationalPIIResults" | "conversationalSummarizationResults";
96
-
97
- // @public
98
- export interface AnalyzeConversationSummarizationResult extends AnalyzeConversationJobResult {
99
- // (undocumented)
100
- kind: "conversationalSummarizationResults";
101
- // (undocumented)
102
- results: SummaryResult;
103
- }
104
-
105
- // @public
106
- export interface AnalyzeConversationSummarizationTask extends AnalyzeConversationLROTask {
107
- parameters?: ConversationSummarizationTaskParameters;
108
- }
109
-
110
- // @public
111
- export interface AnalyzeConversationTask {
112
- kind: "Conversation";
113
- }
114
-
115
- // @public
116
- export type AnalyzeConversationTaskKind = string;
117
-
118
- // @public
119
- export interface AnalyzeConversationTaskResult {
120
- kind: "ConversationResult";
121
- }
122
-
123
- // @public
124
- export type AnalyzeConversationTaskResultsKind = string;
125
-
126
- // @public (undocumented)
127
- export type AnalyzeConversationTaskResultUnion = ConversationalTaskResult;
128
-
129
- // @public (undocumented)
130
- export type AnalyzeConversationTaskUnion = ConversationalTask;
131
-
132
- // @public
133
- export interface AnswersOptions {
134
- answerContext?: KnowledgeBaseAnswerContext;
135
- confidenceThreshold?: number;
136
- filters?: QueryFilters;
137
- includeUnstructuredSources?: boolean;
138
- qnaId?: number;
139
- question?: string;
140
- rankerKind?: RankerKind;
141
- shortAnswerOptions?: ShortAnswerOptions;
142
- top?: number;
143
- userId?: string;
144
- }
145
-
146
- // @public
147
- export interface AnswerSpan {
148
- confidence?: number;
149
- length?: number;
150
- offset?: number;
151
- text?: string;
152
- }
153
-
154
- // @public
155
- export interface AnswersResult {
156
- answers?: KnowledgeBaseAnswer[];
157
- }
158
-
159
- // @public
160
- export interface AreaResolution extends BaseResolution, QuantityResolution {
161
- resolutionKind: "Area";
162
- unit: AreaUnit;
163
- }
164
-
165
- // @public
166
- export type AreaUnit = string;
167
-
168
- // @public
169
- export interface AudioTiming {
170
- duration?: number;
171
- offset?: number;
172
- }
173
-
174
- export { AzureKeyCredential }
175
-
176
- // @public
177
- export interface BaseExtraInformation {
178
- extraInformationKind: "EntitySubtype" | "ListKey";
179
- }
180
-
181
- // @public (undocumented)
182
- export type BaseExtraInformationUnion = EntitySubtype | ListKey;
183
-
184
- // @public
185
- export interface BasePrediction {
186
- projectKind: "Conversation" | "Orchestration";
187
- topIntent?: string;
188
- }
189
-
190
- // @public (undocumented)
191
- export type BasePredictionUnion = ConversationPrediction | OrchestrationPrediction;
192
-
193
- // @public
194
- export interface BaseResolution {
195
- resolutionKind: "Age" | "Volume" | "Speed" | "Area" | "Length" | "Information" | "Temperature" | "Weight" | "Currency" | "Boolean" | "DateTime" | "Number" | "Ordinal" | "TemporalSpan" | "NumericRange";
196
- }
197
-
198
- // @public (undocumented)
199
- export type BaseResolutionUnion = AgeResolution | VolumeResolution | SpeedResolution | AreaResolution | LengthResolution | InformationResolution | TemperatureResolution | WeightResolution | CurrencyResolution | BooleanResolution | DateTimeResolution | NumberResolution | OrdinalResolution | TemporalSpanResolution | NumericRangeResolution;
200
-
201
- // @public
202
- export interface BooleanResolution extends BaseResolution {
203
- resolutionKind: "Boolean";
204
- // (undocumented)
205
- value: boolean;
206
- }
207
-
208
- // @public
209
- export interface Conversation {
210
- domain?: ConversationDomain;
211
- id: string;
212
- language: string;
213
- modality: "text" | "transcript";
214
- }
215
-
216
- // @public
217
- export interface ConversationalTask extends AnalyzeConversationTask {
218
- analysisInput: ConversationAnalysisOptions;
219
- kind: "Conversation";
220
- parameters: ConversationTaskParameters;
221
- }
222
-
223
- // @public
224
- export interface ConversationalTaskResult extends AnalyzeConversationTaskResult {
225
- kind: "ConversationResult";
226
- result: AnalyzeConversationResult;
227
- }
228
-
229
- // @public
230
- export class ConversationAnalysisClient {
231
- constructor(endpoint: string, credential: TokenCredential | KeyCredential, options?: ConversationAnalysisClientOptionalParams);
232
- analyzeConversation(task: AnalyzeConversationTaskUnion, options?: AnalyzeConversationOptionalParams): Promise<AnalyzeConversationResponse>;
233
- beginConversationAnalysis(task: AnalyzeConversationJobsInput, options?: ConversationAnalysisOptionalParams): Promise<PollerLike<PollOperationState<ConversationAnalysisResponse>, ConversationAnalysisResponse>>;
234
- }
235
-
236
- // @public
237
- export interface ConversationAnalysisClientAnalyzeConversationExceptionHeaders {
238
- xMsErrorCode?: string;
239
- }
240
-
241
- // @public
242
- export interface ConversationAnalysisClientConversationAnalysisHeaders {
243
- // (undocumented)
244
- operationLocation?: string;
245
- }
246
-
247
- // @public
248
- export interface ConversationAnalysisClientOptionalParams extends coreClient.ServiceClientOptions {
249
- apiVersion?: string;
250
- endpoint?: string;
251
- }
252
-
253
- // @public
254
- export interface ConversationAnalysisOptionalParams extends coreClient.OperationOptions {
255
- resumeFrom?: string;
256
- updateIntervalInMs?: number;
257
- }
258
-
259
- // @public
260
- export interface ConversationAnalysisOptions {
261
- conversationItem: ConversationItemBase;
262
- }
263
-
264
- // @public
265
- export type ConversationAnalysisResponse = AnalyzeConversationJobState;
266
-
267
- // @public
268
- export interface ConversationCallingOptions {
269
- isLoggingEnabled?: boolean;
270
- language?: string;
271
- verbose?: boolean;
272
- }
273
-
274
- // @public
275
- export type ConversationDomain = string;
276
-
277
- // @public
278
- export interface ConversationEntity {
279
- category: string;
280
- confidence: number;
281
- extraInformation?: BaseExtraInformationUnion[];
282
- length: number;
283
- offset: number;
284
- resolutions?: BaseResolutionUnion[];
285
- text: string;
286
- }
287
-
288
- // @public
289
- export interface ConversationIntent {
290
- category: string;
291
- confidence: number;
292
- }
293
-
294
- // @public
295
- export interface ConversationItemBase {
296
- [property: string]: any;
297
- id: string;
298
- language?: string;
299
- modality?: InputModality;
300
- participantId: string;
301
- role?: Role;
302
- }
303
-
304
- // @public
305
- export interface ConversationParameters extends AnalysisParameters {
306
- callingOptions?: ConversationCallingOptions;
307
- targetProjectKind: "Conversation";
308
- }
309
-
310
- // @public
311
- export type ConversationPIICategory = string;
312
-
313
- // @public (undocumented)
314
- export interface ConversationPIIItemResult {
315
- // (undocumented)
316
- entities: Entity[];
317
- // (undocumented)
318
- id: string;
319
- redactedContent: RedactedTranscriptContent;
320
- }
321
-
322
- // @public
323
- export interface ConversationPIIResult {
324
- conversationItems: ConversationPIIItemResult[];
325
- }
326
-
327
- // @public
328
- export interface ConversationPIIResults extends PreBuiltResult {
329
- // (undocumented)
330
- conversations: ConversationPIIResultsConversationsItem[];
331
- }
332
-
333
- // @public (undocumented)
334
- export interface ConversationPIIResultsConversationsItem extends ConversationPIIResult, ConversationResultBase {
335
- }
336
-
337
- // @public
338
- export interface ConversationPIITaskParameters extends PreBuiltTaskParameters {
339
- includeAudioRedaction?: boolean;
340
- piiCategories?: ConversationPIICategory[];
341
- redactionSource?: TranscriptContentType;
342
- }
343
-
344
- // @public
345
- export interface ConversationPrediction extends BasePrediction {
346
- entities: ConversationEntity[];
347
- intents: ConversationIntent[];
348
- projectKind: "Conversation";
349
- }
350
-
351
- // @public
352
- export interface ConversationRequestStatistics extends RequestStatistics {
353
- conversationsCount: number;
354
- erroneousConversationsCount: number;
355
- validConversationsCount: number;
356
- }
357
-
358
- // @public
359
- export interface ConversationResult {
360
- detectedLanguage?: string;
361
- prediction?: ConversationPrediction;
362
- query: string;
363
- }
364
-
365
- // @public
366
- export interface ConversationResultBase {
367
- id: string;
368
- statistics?: ConversationStatistics;
369
- warnings: InputWarning[];
370
- }
371
-
372
- // @public (undocumented)
373
- export interface ConversationsSummaryResult {
374
- // (undocumented)
375
- summaries: ConversationsSummaryResultSummariesItem[];
376
- }
377
-
378
- // @public (undocumented)
379
- export interface ConversationsSummaryResultSummariesItem extends SummaryResultItem {
380
- }
381
-
382
- // @public
383
- export interface ConversationStatistics {
384
- transactionsCount: number;
385
- }
386
-
387
- // @public
388
- export interface ConversationSummarizationTaskParameters extends PreBuiltTaskParameters {
389
- // (undocumented)
390
- summaryAspects: SummaryAspect[];
391
- }
392
-
393
- // @public
394
- export interface ConversationTargetIntentResult extends TargetIntentResult {
395
- result?: ConversationResult;
396
- targetProjectKind: "Conversation";
397
- }
398
-
399
- // @public
400
- export interface ConversationTaskParameters {
401
- deploymentName: string;
402
- directTarget?: string;
403
- isLoggingEnabled?: boolean;
404
- projectName: string;
405
- stringIndexType?: StringIndexType;
406
- targetProjectParameters?: {
407
- [propertyName: string]: AnalysisParametersUnion;
408
- };
409
- verbose?: boolean;
410
- }
411
-
412
- // @public
413
- export interface ConversationTasksState {
414
- // (undocumented)
415
- tasks: ConversationTasksStateTasks;
416
- }
417
-
418
- // @public (undocumented)
419
- export interface ConversationTasksStateTasks {
420
- completed: number;
421
- failed: number;
422
- inProgress: number;
423
- items?: AnalyzeConversationJobResultUnion[];
424
- total: number;
425
- }
426
-
427
- // @public (undocumented)
428
- export type ConversationUnion = TextConversation | TranscriptConversation;
429
-
430
- // @public
431
- export interface CurrencyResolution extends BaseResolution, QuantityResolution {
432
- iso4217?: string;
433
- resolutionKind: "Currency";
434
- unit: string;
435
- }
436
-
437
- // @public
438
- export interface DateTimeResolution extends BaseResolution {
439
- dateTimeSubKind: DateTimeSubKind;
440
- modifier?: TemporalModifier;
441
- resolutionKind: "DateTime";
442
- timex: string;
443
- value: string;
444
- }
445
-
446
- // @public
447
- export type DateTimeSubKind = string;
448
-
449
- // @public (undocumented)
450
- export interface Entity {
451
- category: string;
452
- confidenceScore: number;
453
- length: number;
454
- offset: number;
455
- subcategory?: string;
456
- text: string;
457
- }
458
-
459
- // @public
460
- export interface EntitySubtype extends BaseExtraInformation {
461
- extraInformationKind: "EntitySubtype";
462
- value?: string;
463
- }
464
-
465
- // @public
466
- export type ErrorCode = string;
467
-
468
- // @public
469
- export interface ErrorModel {
470
- [property: string]: any;
471
- code: ErrorCode;
472
- details?: ErrorModel[];
473
- innererror?: InnerErrorModel;
474
- message: string;
475
- target?: string;
476
- }
477
-
478
- // @public
479
- export interface ErrorResponse {
480
- error: ErrorModel;
481
- }
482
-
483
- // @public
484
- export type ExtraInformationKind = string;
485
-
486
- // @public
487
- export interface InformationResolution extends BaseResolution, QuantityResolution {
488
- resolutionKind: "Information";
489
- unit: InformationUnit;
490
- }
491
-
492
- // @public
493
- export type InformationUnit = string;
494
-
495
- // @public
496
- export type InnerErrorCode = string;
497
-
498
- // @public
499
- export interface InnerErrorModel {
500
- code: InnerErrorCode;
501
- details?: {
502
- [propertyName: string]: string;
503
- };
504
- innererror?: InnerErrorModel;
505
- message: string;
506
- target?: string;
507
- }
508
-
509
- // @public
510
- export interface InputError {
511
- error: ErrorModel;
512
- id: string;
513
- }
514
-
515
- // @public
516
- export type InputModality = string;
517
-
518
- // @public
519
- export interface InputWarning {
520
- code: string;
521
- message: string;
522
- targetRef?: string;
523
- }
524
-
525
- // @public
526
- export type JobState = string;
527
-
528
- // @public (undocumented)
529
- export interface JobStateAutoGenerated {
530
- // (undocumented)
531
- createdDateTime: Date;
532
- // (undocumented)
533
- displayName?: string;
534
- // (undocumented)
535
- errors?: ErrorModel[];
536
- // (undocumented)
537
- expirationDateTime?: Date;
538
- // (undocumented)
539
- jobId: string;
540
- // (undocumented)
541
- lastUpdatedDateTime: Date;
542
- // (undocumented)
543
- nextLink?: string;
544
- // (undocumented)
545
- status: JobState;
546
- }
547
-
548
- // @public
549
- export interface KnowledgeBaseAnswer {
550
- answer?: string;
551
- confidence?: number;
552
- dialog?: KnowledgeBaseAnswerDialog;
553
- metadata?: {
554
- [propertyName: string]: string;
555
- };
556
- qnaId?: number;
557
- questions?: string[];
558
- shortAnswer?: AnswerSpan;
559
- source?: string;
560
- }
561
-
562
- // @public
563
- export interface KnowledgeBaseAnswerContext {
564
- previousQnaId: number;
565
- previousQuestion?: string;
566
- }
567
-
568
- // @public
569
- export interface KnowledgeBaseAnswerDialog {
570
- isContextOnly?: boolean;
571
- prompts?: KnowledgeBaseAnswerPrompt[];
572
- }
573
-
574
- // @public
575
- export interface KnowledgeBaseAnswerPrompt {
576
- displayOrder?: number;
577
- displayText?: string;
578
- qnaId?: number;
579
- }
580
-
581
- // @public
582
- export enum KnownAgeUnit {
583
- Day = "Day",
584
- Month = "Month",
585
- Unspecified = "Unspecified",
586
- Week = "Week",
587
- Year = "Year"
588
- }
589
-
590
- // @public
591
- export enum KnownAnalyzeConversationLROTaskKind {
592
- ConversationalPIITask = "ConversationalPIITask",
593
- ConversationalSummarizationTask = "ConversationalSummarizationTask"
594
- }
595
-
596
- // @public
597
- export enum KnownAnalyzeConversationResultsKind {
598
- ConversationalPIIResults = "ConversationalPIIResults",
599
- ConversationalSummarizationResults = "ConversationalSummarizationResults"
600
- }
601
-
602
- // @public
603
- export enum KnownAnalyzeConversationTaskKind {
604
- Conversation = "Conversation"
605
- }
606
-
607
- // @public
608
- export enum KnownAnalyzeConversationTaskResultsKind {
609
- ConversationResult = "ConversationResult"
610
- }
611
-
612
- // @public
613
- export enum KnownAreaUnit {
614
- Acre = "Acre",
615
- SquareCentimeter = "SquareCentimeter",
616
- SquareDecameter = "SquareDecameter",
617
- SquareDecimeter = "SquareDecimeter",
618
- SquareFoot = "SquareFoot",
619
- SquareHectometer = "SquareHectometer",
620
- SquareInch = "SquareInch",
621
- SquareKilometer = "SquareKilometer",
622
- SquareMeter = "SquareMeter",
623
- SquareMile = "SquareMile",
624
- SquareMillimeter = "SquareMillimeter",
625
- SquareYard = "SquareYard",
626
- Unspecified = "Unspecified"
627
- }
628
-
629
- // @public
630
- export enum KnownConversationDomain {
631
- Finance = "finance",
632
- Generic = "generic",
633
- Healthcare = "healthcare"
634
- }
635
-
636
- // @public
637
- export enum KnownConversationPIICategory {
638
- Address = "Address",
639
- All = "All",
640
- CreditCard = "CreditCard",
641
- Default = "Default",
642
- Email = "Email",
643
- Name = "Name",
644
- NumericIdentifier = "NumericIdentifier",
645
- PhoneNumber = "PhoneNumber"
646
- }
647
-
648
- // @public
649
- export enum KnownDateTimeSubKind {
650
- Date = "Date",
651
- DateTime = "DateTime",
652
- Duration = "Duration",
653
- Set = "Set",
654
- Time = "Time"
655
- }
656
-
657
- // @public
658
- export enum KnownErrorCode {
659
- AzureCognitiveSearchIndexLimitReached = "AzureCognitiveSearchIndexLimitReached",
660
- AzureCognitiveSearchIndexNotFound = "AzureCognitiveSearchIndexNotFound",
661
- AzureCognitiveSearchNotFound = "AzureCognitiveSearchNotFound",
662
- AzureCognitiveSearchThrottling = "AzureCognitiveSearchThrottling",
663
- Conflict = "Conflict",
664
- Forbidden = "Forbidden",
665
- InternalServerError = "InternalServerError",
666
- InvalidArgument = "InvalidArgument",
667
- InvalidRequest = "InvalidRequest",
668
- NotFound = "NotFound",
669
- OperationNotFound = "OperationNotFound",
670
- ProjectNotFound = "ProjectNotFound",
671
- QuotaExceeded = "QuotaExceeded",
672
- ServiceUnavailable = "ServiceUnavailable",
673
- Timeout = "Timeout",
674
- TooManyRequests = "TooManyRequests",
675
- Unauthorized = "Unauthorized",
676
- Warning = "Warning"
677
- }
678
-
679
- // @public
680
- export enum KnownExtraInformationKind {
681
- EntitySubtype = "EntitySubtype",
682
- ListKey = "ListKey"
683
- }
684
-
685
- // @public
686
- export enum KnownInformationUnit {
687
- Bit = "Bit",
688
- Byte = "Byte",
689
- Gigabit = "Gigabit",
690
- Gigabyte = "Gigabyte",
691
- Kilobit = "Kilobit",
692
- Kilobyte = "Kilobyte",
693
- Megabit = "Megabit",
694
- Megabyte = "Megabyte",
695
- Petabit = "Petabit",
696
- Petabyte = "Petabyte",
697
- Terabit = "Terabit",
698
- Terabyte = "Terabyte",
699
- Unspecified = "Unspecified"
700
- }
701
-
702
- // @public
703
- export enum KnownInnerErrorCode {
704
- AzureCognitiveSearchNotFound = "AzureCognitiveSearchNotFound",
705
- AzureCognitiveSearchThrottling = "AzureCognitiveSearchThrottling",
706
- EmptyRequest = "EmptyRequest",
707
- ExtractionFailure = "ExtractionFailure",
708
- InvalidCountryHint = "InvalidCountryHint",
709
- InvalidDocument = "InvalidDocument",
710
- InvalidDocumentBatch = "InvalidDocumentBatch",
711
- InvalidParameterValue = "InvalidParameterValue",
712
- InvalidRequest = "InvalidRequest",
713
- InvalidRequestBodyFormat = "InvalidRequestBodyFormat",
714
- KnowledgeBaseNotFound = "KnowledgeBaseNotFound",
715
- MissingInputDocuments = "MissingInputDocuments",
716
- ModelVersionIncorrect = "ModelVersionIncorrect",
717
- UnsupportedLanguageCode = "UnsupportedLanguageCode"
718
- }
719
-
720
- // @public
721
- export enum KnownInputModality {
722
- Text = "text",
723
- Transcript = "transcript"
724
- }
725
-
726
- // @public
727
- export enum KnownJobState {
728
- Cancelled = "cancelled",
729
- Cancelling = "cancelling",
730
- Failed = "failed",
731
- NotStarted = "notStarted",
732
- PartiallyCompleted = "partiallyCompleted",
733
- Running = "running",
734
- Succeeded = "succeeded"
735
- }
736
-
737
- // @public
738
- export enum KnownLengthUnit {
739
- Centimeter = "Centimeter",
740
- Decameter = "Decameter",
741
- Decimeter = "Decimeter",
742
- Foot = "Foot",
743
- Hectometer = "Hectometer",
744
- Inch = "Inch",
745
- Kilometer = "Kilometer",
746
- LightYear = "LightYear",
747
- Meter = "Meter",
748
- Micrometer = "Micrometer",
749
- Mile = "Mile",
750
- Millimeter = "Millimeter",
751
- Nanometer = "Nanometer",
752
- Picometer = "Picometer",
753
- Pt = "Pt",
754
- Unspecified = "Unspecified",
755
- Yard = "Yard"
756
- }
757
-
758
- // @public
759
- export enum KnownLogicalOperationKind {
760
- AND = "AND",
761
- OR = "OR"
762
- }
763
-
764
- // @public
765
- export enum KnownNumberKind {
766
- Decimal = "Decimal",
767
- Fraction = "Fraction",
768
- Integer = "Integer",
769
- Percent = "Percent",
770
- Power = "Power",
771
- Unspecified = "Unspecified"
772
- }
773
-
774
- // @public
775
- export enum KnownProjectKind {
776
- Conversation = "Conversation",
777
- Orchestration = "Orchestration"
778
- }
779
-
780
- // @public
781
- export enum KnownRangeKind {
782
- Age = "Age",
783
- Area = "Area",
784
- Currency = "Currency",
785
- Information = "Information",
786
- Length = "Length",
787
- Number = "Number",
788
- Speed = "Speed",
789
- Temperature = "Temperature",
790
- Volume = "Volume",
791
- Weight = "Weight"
792
- }
793
-
794
- // @public
795
- export enum KnownRankerKind {
796
- Default = "Default",
797
- QuestionOnly = "QuestionOnly"
798
- }
799
-
800
- // @public
801
- export enum KnownRelativeTo {
802
- Current = "Current",
803
- End = "End",
804
- Start = "Start"
805
- }
806
-
807
- // @public
808
- export enum KnownResolutionKind {
809
- Age = "Age",
810
- Area = "Area",
811
- Boolean = "Boolean",
812
- Currency = "Currency",
813
- DateTime = "DateTime",
814
- Information = "Information",
815
- Length = "Length",
816
- Number = "Number",
817
- NumericRange = "NumericRange",
818
- Ordinal = "Ordinal",
819
- Speed = "Speed",
820
- Temperature = "Temperature",
821
- TemporalSpan = "TemporalSpan",
822
- Volume = "Volume",
823
- Weight = "Weight"
824
- }
825
-
826
- // @public
827
- export enum KnownRole {
828
- Agent = "agent",
829
- Customer = "customer",
830
- Generic = "generic"
831
- }
832
-
833
- // @public
834
- export enum KnownSpeedUnit {
835
- CentimetersPerMillisecond = "CentimetersPerMillisecond",
836
- FootPerMinute = "FootPerMinute",
837
- FootPerSecond = "FootPerSecond",
838
- KilometersPerHour = "KilometersPerHour",
839
- KilometersPerMillisecond = "KilometersPerMillisecond",
840
- KilometersPerMinute = "KilometersPerMinute",
841
- KilometersPerSecond = "KilometersPerSecond",
842
- Knot = "Knot",
843
- MetersPerMillisecond = "MetersPerMillisecond",
844
- MetersPerSecond = "MetersPerSecond",
845
- MilesPerHour = "MilesPerHour",
846
- Unspecified = "Unspecified",
847
- YardsPerMinute = "YardsPerMinute",
848
- YardsPerSecond = "YardsPerSecond"
849
- }
850
-
851
- // @public
852
- export enum KnownStringIndexType {
853
- TextElementsV8 = "TextElements_v8",
854
- UnicodeCodePoint = "UnicodeCodePoint",
855
- Utf16CodeUnit = "Utf16CodeUnit"
856
- }
857
-
858
- // @public
859
- export enum KnownSummaryAspect {
860
- Issue = "issue",
861
- Resolution = "resolution"
862
- }
863
-
864
- // @public
865
- export enum KnownTargetProjectKind {
866
- Conversation = "Conversation",
867
- Luis = "Luis",
868
- NonLinked = "NonLinked",
869
- QuestionAnswering = "QuestionAnswering"
870
- }
871
-
872
- // @public
873
- export enum KnownTaskState {
874
- Cancelled = "cancelled",
875
- Cancelling = "cancelling",
876
- Failed = "failed",
877
- NotStarted = "notStarted",
878
- Running = "running",
879
- Succeeded = "succeeded"
880
- }
881
-
882
- // @public
883
- export enum KnownTemperatureUnit {
884
- Celsius = "Celsius",
885
- Fahrenheit = "Fahrenheit",
886
- Kelvin = "Kelvin",
887
- Rankine = "Rankine",
888
- Unspecified = "Unspecified"
889
- }
890
-
891
- // @public
892
- export enum KnownTemporalModifier {
893
- After = "After",
894
- AfterApprox = "AfterApprox",
895
- AfterMid = "AfterMid",
896
- AfterStart = "AfterStart",
897
- Approx = "Approx",
898
- Before = "Before",
899
- BeforeApprox = "BeforeApprox",
900
- BeforeEnd = "BeforeEnd",
901
- BeforeStart = "BeforeStart",
902
- End = "End",
903
- Less = "Less",
904
- Mid = "Mid",
905
- More = "More",
906
- ReferenceUndefined = "ReferenceUndefined",
907
- Since = "Since",
908
- SinceEnd = "SinceEnd",
909
- Start = "Start",
910
- Until = "Until"
911
- }
912
-
913
- // @public
914
- export enum KnownTranscriptContentType {
915
- Itn = "itn",
916
- Lexical = "lexical",
917
- MaskedItn = "maskedItn",
918
- Text = "text"
919
- }
920
-
921
- // @public
922
- export enum KnownVolumeUnit {
923
- Barrel = "Barrel",
924
- Bushel = "Bushel",
925
- Centiliter = "Centiliter",
926
- Cord = "Cord",
927
- CubicCentimeter = "CubicCentimeter",
928
- CubicFoot = "CubicFoot",
929
- CubicInch = "CubicInch",
930
- CubicMeter = "CubicMeter",
931
- CubicMile = "CubicMile",
932
- CubicMillimeter = "CubicMillimeter",
933
- CubicYard = "CubicYard",
934
- Cup = "Cup",
935
- Decaliter = "Decaliter",
936
- FluidDram = "FluidDram",
937
- FluidOunce = "FluidOunce",
938
- Gill = "Gill",
939
- Hectoliter = "Hectoliter",
940
- Hogshead = "Hogshead",
941
- Liter = "Liter",
942
- Milliliter = "Milliliter",
943
- Minim = "Minim",
944
- Peck = "Peck",
945
- Pinch = "Pinch",
946
- Pint = "Pint",
947
- Quart = "Quart",
948
- Tablespoon = "Tablespoon",
949
- Teaspoon = "Teaspoon",
950
- Unspecified = "Unspecified"
951
- }
952
-
953
- // @public
954
- export enum KnownWeightUnit {
955
- Dram = "Dram",
956
- Gallon = "Gallon",
957
- Grain = "Grain",
958
- Gram = "Gram",
959
- Kilogram = "Kilogram",
960
- LongTonBritish = "LongTonBritish",
961
- MetricTon = "MetricTon",
962
- Milligram = "Milligram",
963
- Ounce = "Ounce",
964
- PennyWeight = "PennyWeight",
965
- Pound = "Pound",
966
- ShortHundredWeightUS = "ShortHundredWeightUS",
967
- ShortTonUS = "ShortTonUS",
968
- Stone = "Stone",
969
- Ton = "Ton",
970
- Unspecified = "Unspecified"
971
- }
972
-
973
- // @public
974
- export interface LengthResolution extends BaseResolution, QuantityResolution {
975
- resolutionKind: "Length";
976
- unit: LengthUnit;
977
- }
978
-
979
- // @public
980
- export type LengthUnit = string;
981
-
982
- // @public
983
- export interface ListKey extends BaseExtraInformation {
984
- extraInformationKind: "ListKey";
985
- key?: string;
986
- }
987
-
988
- // @public
989
- export type LogicalOperationKind = string;
990
-
991
- // @public
992
- export interface LuisCallingOptions {
993
- bingSpellCheckSubscriptionKey?: string;
994
- log?: boolean;
995
- showAllIntents?: boolean;
996
- spellCheck?: boolean;
997
- timezoneOffset?: number;
998
- verbose?: boolean;
999
- }
1000
-
1001
- // @public
1002
- export interface LuisParameters extends AnalysisParameters {
1003
- [property: string]: any;
1004
- callingOptions?: LuisCallingOptions;
1005
- query?: string;
1006
- targetProjectKind: "Luis";
1007
- }
1008
-
1009
- // @public
1010
- export interface LuisTargetIntentResult extends TargetIntentResult {
1011
- result?: Record<string, ConversationPrediction>;
1012
- targetProjectKind: "Luis";
1013
- }
1014
-
1015
- // @public
1016
- export interface MetadataFilter {
1017
- logicalOperation?: LogicalOperationKind;
1018
- // (undocumented)
1019
- metadata?: MetadataRecord[];
1020
- }
1021
-
1022
- // @public
1023
- export interface MetadataRecord {
1024
- key: string;
1025
- value: string;
1026
- }
1027
-
1028
- // @public (undocumented)
1029
- export interface MultiLanguageConversationAnalysisInput {
1030
- // (undocumented)
1031
- conversations: ConversationUnion[];
1032
- }
1033
-
1034
- // @public
1035
- export interface NoneLinkedTargetIntentResult extends TargetIntentResult {
1036
- result?: ConversationResult;
1037
- targetProjectKind: "NonLinked";
1038
- }
1039
-
1040
- // @public
1041
- export type NumberKind = string;
1042
-
1043
- // @public
1044
- export interface NumberResolution extends BaseResolution {
1045
- numberKind: NumberKind;
1046
- resolutionKind: "Number";
1047
- value: string;
1048
- }
1049
-
1050
- // @public
1051
- export interface NumericRangeResolution extends BaseResolution {
1052
- maximum: number;
1053
- minimum: number;
1054
- rangeKind: RangeKind;
1055
- resolutionKind: "NumericRange";
1056
- }
1057
-
1058
- // @public
1059
- export interface OrchestrationPrediction extends BasePrediction {
1060
- intents: {
1061
- [propertyName: string]: TargetIntentResultUnion;
1062
- };
1063
- projectKind: "Orchestration";
1064
- }
1065
-
1066
- // @public
1067
- export interface OrdinalResolution extends BaseResolution {
1068
- offset: string;
1069
- relativeTo: RelativeTo;
1070
- resolutionKind: "Ordinal";
1071
- value: string;
1072
- }
1073
-
1074
- // @public (undocumented)
1075
- export interface PreBuiltResult {
1076
- errors: InputError[];
1077
- modelVersion: string;
1078
- statistics?: RequestStatistics;
1079
- }
1080
-
1081
- // @public
1082
- export interface PreBuiltTaskParameters extends TaskParameters {
1083
- // (undocumented)
1084
- modelVersion?: string;
1085
- }
1086
-
1087
- // @public
1088
- export type ProjectKind = string;
1089
-
1090
- // @public
1091
- export interface QuantityResolution {
1092
- value: number;
1093
- }
1094
-
1095
- // @public
1096
- export interface QueryFilters {
1097
- logicalOperation?: LogicalOperationKind;
1098
- metadataFilter?: MetadataFilter;
1099
- sourceFilter?: string[];
1100
- }
1101
-
1102
- // @public
1103
- export interface QuestionAnsweringParameters extends AnalysisParameters {
1104
- callingOptions?: AnswersOptions;
1105
- targetProjectKind: "QuestionAnswering";
1106
- }
1107
-
1108
- // @public
1109
- export interface QuestionAnsweringTargetIntentResult extends TargetIntentResult {
1110
- result?: AnswersResult;
1111
- targetProjectKind: "QuestionAnswering";
1112
- }
1113
-
1114
- // @public
1115
- export type RangeKind = string;
1116
-
1117
- // @public
1118
- export type RankerKind = string;
1119
-
1120
- // @public
1121
- export interface RedactedTranscriptContent {
1122
- audioTimings?: AudioTiming[];
1123
- itn?: string;
1124
- lexical?: string;
1125
- maskedItn?: string;
1126
- text?: string;
1127
- }
1128
-
1129
- // @public
1130
- export type RelativeTo = string;
1131
-
1132
- // @public
1133
- export interface RequestStatistics {
1134
- [property: string]: any;
1135
- transactionsCount: number;
1136
- }
1137
-
1138
- // @public
1139
- export type ResolutionKind = string;
1140
-
1141
- // @public
1142
- export type Role = string;
1143
-
1144
- // @public
1145
- export interface ShortAnswerOptions {
1146
- confidenceThreshold?: number;
1147
- enable: true;
1148
- top?: number;
1149
- }
1150
-
1151
- // @public
1152
- export interface SpeedResolution extends BaseResolution, QuantityResolution {
1153
- resolutionKind: "Speed";
1154
- unit: SpeedUnit;
1155
- }
1156
-
1157
- // @public
1158
- export type SpeedUnit = string;
1159
-
1160
- // @public
1161
- export type StringIndexType = string;
1162
-
1163
- // @public
1164
- export type SummaryAspect = string;
1165
-
1166
- // @public (undocumented)
1167
- export interface SummaryResult extends PreBuiltResult {
1168
- // (undocumented)
1169
- conversations: SummaryResultConversationsItem[];
1170
- }
1171
-
1172
- // @public (undocumented)
1173
- export interface SummaryResultConversationsItem extends ConversationsSummaryResult, ConversationResultBase {
1174
- }
1175
-
1176
- // @public (undocumented)
1177
- export interface SummaryResultItem {
1178
- // (undocumented)
1179
- aspect: string;
1180
- // (undocumented)
1181
- text: string;
1182
- }
1183
-
1184
- // @public
1185
- export interface TargetIntentResult {
1186
- apiVersion?: string;
1187
- confidence: number;
1188
- targetProjectKind: "NonLinked" | "Conversation" | "Luis" | "QuestionAnswering";
1189
- }
1190
-
1191
- // @public (undocumented)
1192
- export type TargetIntentResultUnion = NoneLinkedTargetIntentResult | ConversationTargetIntentResult | LuisTargetIntentResult | QuestionAnsweringTargetIntentResult;
1193
-
1194
- // @public
1195
- export type TargetProjectKind = string;
1196
-
1197
- // @public
1198
- export interface TaskIdentifier {
1199
- // (undocumented)
1200
- taskName?: string;
1201
- }
1202
-
1203
- // @public
1204
- export interface TaskParameters {
1205
- // (undocumented)
1206
- loggingOptOut?: boolean;
1207
- }
1208
-
1209
- // @public
1210
- export type TaskState = string;
1211
-
1212
- // @public
1213
- export interface TaskStateAutoGenerated {
1214
- lastUpdateDateTime: Date;
1215
- status: TaskState;
1216
- }
1217
-
1218
- // @public
1219
- export interface TemperatureResolution extends BaseResolution, QuantityResolution {
1220
- resolutionKind: "Temperature";
1221
- unit: TemperatureUnit;
1222
- }
1223
-
1224
- // @public
1225
- export type TemperatureUnit = string;
1226
-
1227
- // @public
1228
- export type TemporalModifier = string;
1229
-
1230
- // @public
1231
- export interface TemporalSpanResolution extends BaseResolution {
1232
- begin?: string;
1233
- duration?: string;
1234
- end?: string;
1235
- modifier?: TemporalModifier;
1236
- resolutionKind: "TemporalSpan";
1237
- }
1238
-
1239
- // @public (undocumented)
1240
- export interface TextConversation extends Conversation {
1241
- conversationItems: TextConversationItem[];
1242
- modality: "text";
1243
- }
1244
-
1245
- // @public
1246
- export interface TextConversationItem extends ConversationItemBase {
1247
- text: string;
1248
- }
1249
-
1250
- // @public
1251
- export type TranscriptContentType = string;
1252
-
1253
- // @public (undocumented)
1254
- export interface TranscriptConversation extends Conversation {
1255
- conversationItems: TranscriptConversationItem[];
1256
- modality: "transcript";
1257
- }
1258
-
1259
- // @public
1260
- export interface TranscriptConversationItem extends ConversationItemBase {
1261
- audioTimings?: WordLevelTiming[];
1262
- itn?: string;
1263
- lexical?: string;
1264
- maskedItn?: string;
1265
- text?: string;
1266
- }
1267
-
1268
- // @public
1269
- export interface VolumeResolution extends BaseResolution, QuantityResolution {
1270
- resolutionKind: "Volume";
1271
- unit: VolumeUnit;
1272
- }
1273
-
1274
- // @public
1275
- export type VolumeUnit = string;
1276
-
1277
- // @public
1278
- export interface WeightResolution extends BaseResolution, QuantityResolution {
1279
- resolutionKind: "Weight";
1280
- unit: WeightUnit;
1281
- }
1282
-
1283
- // @public
1284
- export type WeightUnit = string;
1285
-
1286
- // @public
1287
- export interface WordLevelTiming extends AudioTiming {
1288
- word?: string;
1289
- }
1290
-
1291
- ```