-
Notifications
You must be signed in to change notification settings - Fork 180
/
ConversationTranscriptionResult.yml
200 lines (200 loc) · 6.89 KB
/
ConversationTranscriptionResult.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
### YamlMime:TSType
name: ConversationTranscriptionResult
uid: microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult
package: microsoft-cognitiveservices-speech-sdk
summary: Defines result of conversation transcription.
fullName: ConversationTranscriptionResult
remarks: ''
isDeprecated: false
type: class
constructors:
- name: >-
ConversationTranscriptionResult(string, ResultReason, string, number,
number, string, string, string, string, string, PropertyCollection)
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.constructor
package: microsoft-cognitiveservices-speech-sdk
summary: Creates and initializes an instance of this class.
remarks: ''
isDeprecated: false
syntax:
content: >-
new ConversationTranscriptionResult(resultId?: string, reason?:
ResultReason, text?: string, duration?: number, offset?: number,
language?: string, languageDetectionConfidence?: string, speakerId?:
string, errorDetails?: string, json?: string, properties?:
PropertyCollection)
parameters:
- id: resultId
type: string
description: The result id.
- id: reason
type: <xref uid="microsoft-cognitiveservices-speech-sdk.ResultReason" />
description: The reason.
- id: text
type: string
description: The recognized text.
- id: duration
type: number
description: The duration.
- id: offset
type: number
description: The offset into the stream.
- id: language
type: string
description: Primary Language detected, if provided.
- id: languageDetectionConfidence
type: string
description: >-
Primary Language confidence ("Unknown," "Low," "Medium," "High"...),
if provided.
- id: speakerId
type: string
description: speaker id for conversation transcription.
- id: errorDetails
type: string
description: Error details, if provided.
- id: json
type: string
description: Additional Json, if provided.
- id: properties
type: >-
<xref
uid="microsoft-cognitiveservices-speech-sdk.PropertyCollection" />
description: Additional properties, if provided.
properties:
- name: duration
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.duration
package: microsoft-cognitiveservices-speech-sdk
summary: Duration of recognized speech in 100 nano second increments.
fullName: duration
remarks: ''
isDeprecated: false
syntax:
content: number duration
return:
description: Duration of recognized speech in 100 nano second increments.
type: number
- name: errorDetails
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.errorDetails
package: microsoft-cognitiveservices-speech-sdk
summary: >-
In case of an unsuccessful recognition, provides details of the occurred
error.
fullName: errorDetails
remarks: ''
isDeprecated: false
syntax:
content: string errorDetails
return:
description: a brief description of an error.
type: string
- name: language
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.language
package: microsoft-cognitiveservices-speech-sdk
summary: Primary Language detected.
fullName: language
remarks: ''
isDeprecated: false
syntax:
content: string language
return:
description: language detected.
type: string
- name: languageDetectionConfidence
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.languageDetectionConfidence
package: microsoft-cognitiveservices-speech-sdk
summary: Primary Language detection confidence (Unknown, Low, Medium, High).
fullName: languageDetectionConfidence
remarks: ''
isDeprecated: false
syntax:
content: string languageDetectionConfidence
return:
description: detection confidence strength.
type: string
- name: offset
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.offset
package: microsoft-cognitiveservices-speech-sdk
summary: Offset of recognized speech in 100 nano second increments.
fullName: offset
remarks: ''
isDeprecated: false
syntax:
content: number offset
return:
description: Offset of recognized speech in 100 nano second increments.
type: number
- name: properties
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.properties
package: microsoft-cognitiveservices-speech-sdk
summary: The set of properties exposed in the result.
fullName: properties
remarks: ''
isDeprecated: false
syntax:
content: PropertyCollection properties
return:
description: The set of properties exposed in the result.
type: >-
<xref uid="microsoft-cognitiveservices-speech-sdk.PropertyCollection"
/>
- name: reason
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.reason
package: microsoft-cognitiveservices-speech-sdk
summary: Specifies status of the result.
fullName: reason
remarks: ''
isDeprecated: false
syntax:
content: ResultReason reason
return:
description: Specifies status of the result.
type: <xref uid="microsoft-cognitiveservices-speech-sdk.ResultReason" />
- name: resultId
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.resultId
package: microsoft-cognitiveservices-speech-sdk
summary: Specifies the result identifier.
fullName: resultId
remarks: ''
isDeprecated: false
syntax:
content: string resultId
return:
description: Specifies the result identifier.
type: string
- name: speakerId
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.speakerId
package: microsoft-cognitiveservices-speech-sdk
summary: speaker id
fullName: speakerId
remarks: ''
isDeprecated: false
syntax:
content: string speakerId
return:
description: id of speaker in given result
type: string
- name: text
uid: >-
microsoft-cognitiveservices-speech-sdk.ConversationTranscriptionResult.text
package: microsoft-cognitiveservices-speech-sdk
summary: Presents the recognized text in the result.
fullName: text
remarks: ''
isDeprecated: false
syntax:
content: string text
return:
description: Presents the recognized text in the result.
type: string
extends: <xref uid="microsoft-cognitiveservices-speech-sdk.RecognitionResult" />