-
Notifications
You must be signed in to change notification settings - Fork 260
/
PronunciationAssessmentConfig.xml
269 lines (268 loc) · 16.7 KB
/
PronunciationAssessmentConfig.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<Type Name="PronunciationAssessmentConfig" FullName="Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig">
<TypeSignature Language="C#" Value="public class PronunciationAssessmentConfig" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PronunciationAssessmentConfig extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig" />
<TypeSignature Language="VB.NET" Value="Public Class PronunciationAssessmentConfig" />
<TypeSignature Language="F#" Value="type PronunciationAssessmentConfig = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.16.0.28</AssemblyVersion>
<AssemblyVersion>1.17.0.28</AssemblyVersion>
<AssemblyVersion>1.18.0.28</AssemblyVersion>
<AssemblyVersion>1.19.0.28</AssemblyVersion>
<AssemblyVersion>1.20.0.28</AssemblyVersion>
<AssemblyVersion>1.21.0.28</AssemblyVersion>
<AssemblyVersion>1.22.0.28</AssemblyVersion>
<AssemblyVersion>1.23.0.28</AssemblyVersion>
<AssemblyVersion>1.24.0.28</AssemblyVersion>
<AssemblyVersion>1.24.1.28</AssemblyVersion>
<AssemblyVersion>1.25.1.26</AssemblyVersion>
<AssemblyVersion>1.27.0.28</AssemblyVersion>
<AssemblyVersion>1.28.0.28</AssemblyVersion>
<AssemblyVersion>1.30.0.28</AssemblyVersion>
<AssemblyVersion>1.31.0.28</AssemblyVersion>
<AssemblyVersion>1.32.1.28</AssemblyVersion>
<AssemblyVersion>1.34.0.28</AssemblyVersion>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Configures a pronunciation assessment.
Added in 1.14.0
</summary>
<remarks>
See also: [Pronunciation assessment](/azure/cognitive-services/speech-service/how-to-pronunciation-assessment?pivots=programming-language-csharp#pronunciation-assessment-with-the-speech-sdk)
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PronunciationAssessmentConfig (string referenceText, Microsoft.CognitiveServices.Speech.PronunciationAssessment.GradingSystem gradingSystem = Microsoft.CognitiveServices.Speech.PronunciationAssessment.GradingSystem.FivePoint, Microsoft.CognitiveServices.Speech.PronunciationAssessment.Granularity granularity = Microsoft.CognitiveServices.Speech.PronunciationAssessment.Granularity.Phoneme, bool enableMiscue = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string referenceText, valuetype Microsoft.CognitiveServices.Speech.PronunciationAssessment.GradingSystem gradingSystem, valuetype Microsoft.CognitiveServices.Speech.PronunciationAssessment.Granularity granularity, bool enableMiscue) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.#ctor(System.String,Microsoft.CognitiveServices.Speech.PronunciationAssessment.GradingSystem,Microsoft.CognitiveServices.Speech.PronunciationAssessment.Granularity,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (referenceText As String, Optional gradingSystem As GradingSystem = Microsoft.CognitiveServices.Speech.PronunciationAssessment.GradingSystem.FivePoint, Optional granularity As Granularity = Microsoft.CognitiveServices.Speech.PronunciationAssessment.Granularity.Phoneme, Optional enableMiscue As Boolean = false)" />
<MemberSignature Language="F#" Value="new Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig : string * Microsoft.CognitiveServices.Speech.PronunciationAssessment.GradingSystem * Microsoft.CognitiveServices.Speech.PronunciationAssessment.Granularity * bool -> Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig" Usage="new Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig (referenceText, gradingSystem, granularity, enableMiscue)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="referenceText" Type="System.String" />
<Parameter Name="gradingSystem" Type="Microsoft.CognitiveServices.Speech.PronunciationAssessment.GradingSystem" />
<Parameter Name="granularity" Type="Microsoft.CognitiveServices.Speech.PronunciationAssessment.Granularity" />
<Parameter Name="enableMiscue" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="referenceText">The reference text to evaluate against</param>
<param name="gradingSystem">The point system for score calibration</param>
<param name="granularity">The evaluation granularity</param>
<param name="enableMiscue">Miscue option. When true, the pronounced words are compared to the reference text, and are marked with omission/insertion based on the comparison; when false, the recognized text will always be reference text.</param>
<summary>
Creates an instance of the PronunciationAssessmentConfig.
</summary>
<returns>A new PronunciationAssessmentConfig instance.</returns>
<remarks>
See also: [Pronunciation assessment](/azure/cognitive-services/speech-service/how-to-pronunciation-assessment?pivots=programming-language-csharp#pronunciation-assessment-with-the-speech-sdk)
</remarks>
</Docs>
</Member>
<Member MemberName="ApplyTo">
<MemberSignature Language="C#" Value="public void ApplyTo (Microsoft.CognitiveServices.Speech.Recognizer recognizer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ApplyTo(class Microsoft.CognitiveServices.Speech.Recognizer recognizer) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.ApplyTo(Microsoft.CognitiveServices.Speech.Recognizer)" />
<MemberSignature Language="VB.NET" Value="Public Sub ApplyTo (recognizer As Recognizer)" />
<MemberSignature Language="F#" Value="member this.ApplyTo : Microsoft.CognitiveServices.Speech.Recognizer -> unit" Usage="pronunciationAssessmentConfig.ApplyTo recognizer" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="recognizer" Type="Microsoft.CognitiveServices.Speech.Recognizer" />
</Parameters>
<Docs>
<param name="recognizer">The target recognizer.</param>
<summary>
Applies the settings in this config to a recognizer.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableContentAssessmentWithTopic">
<MemberSignature Language="C#" Value="public void EnableContentAssessmentWithTopic (string topic);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EnableContentAssessmentWithTopic(string topic) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.EnableContentAssessmentWithTopic(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub EnableContentAssessmentWithTopic (topic As String)" />
<MemberSignature Language="F#" Value="member this.EnableContentAssessmentWithTopic : string -> unit" Usage="pronunciationAssessmentConfig.EnableContentAssessmentWithTopic topic" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="topic" Type="System.String" />
</Parameters>
<Docs>
<param name="topic">the topic</param>
<summary>
Enables content assessment with the specified topic.
Added in 1.33.0
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EnableProsodyAssessment">
<MemberSignature Language="C#" Value="public void EnableProsodyAssessment ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void EnableProsodyAssessment() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.EnableProsodyAssessment" />
<MemberSignature Language="VB.NET" Value="Public Sub EnableProsodyAssessment ()" />
<MemberSignature Language="F#" Value="member this.EnableProsodyAssessment : unit -> unit" Usage="pronunciationAssessmentConfig.EnableProsodyAssessment " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Enables prosody assessment.
Added in 1.33.0
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FromJson">
<MemberSignature Language="C#" Value="public static Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig FromJson (string json);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig FromJson(string json) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.FromJson(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function FromJson (json As String) As PronunciationAssessmentConfig" />
<MemberSignature Language="F#" Value="static member FromJson : string -> Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig" Usage="Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.FromJson json" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="json" Type="System.String" />
</Parameters>
<Docs>
<param name="json">The JSON-formatted string containing the pronunciation assessment parameters.</param>
<summary>
Creates an instance of the PronunciationAssessmentConfig from JSON-formatted text.
</summary>
<returns>A new PronunciationAssessmentConfig instance.</returns>
<remarks>
You can use JSON-formatted text rather than constructor parameters to configure the pronunciation assessment.
See also: [Pronunciation assessment parameters](/azure/cognitive-services/speech-service/rest-speech-to-text#pronunciation-assessment-parameters)
</remarks>
</Docs>
</Member>
<Member MemberName="NBestPhonemeCount">
<MemberSignature Language="C#" Value="public int NBestPhonemeCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 NBestPhonemeCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.NBestPhonemeCount" />
<MemberSignature Language="VB.NET" Value="Public Property NBestPhonemeCount As Integer" />
<MemberSignature Language="F#" Value="member this.NBestPhonemeCount : int with get, set" Usage="Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.NBestPhonemeCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
The nbest phoneme count.
Added in 1.20.0
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PhonemeAlphabet">
<MemberSignature Language="C#" Value="public string PhonemeAlphabet { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PhonemeAlphabet" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.PhonemeAlphabet" />
<MemberSignature Language="VB.NET" Value="Public Property PhonemeAlphabet As String" />
<MemberSignature Language="F#" Value="member this.PhonemeAlphabet : string with get, set" Usage="Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.PhonemeAlphabet" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The phoneme alphabet. Valid values are: "SAPI" (default) and "IPA".
Added in 1.20.0
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReferenceText">
<MemberSignature Language="C#" Value="public string ReferenceText { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ReferenceText" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.ReferenceText" />
<MemberSignature Language="VB.NET" Value="Public Property ReferenceText As String" />
<MemberSignature Language="F#" Value="member this.ReferenceText : string with get, set" Usage="Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.ReferenceText" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Contains text used to compare with a pronunciation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToJson">
<MemberSignature Language="C#" Value="public string ToJson ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string ToJson() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.PronunciationAssessment.PronunciationAssessmentConfig.ToJson" />
<MemberSignature Language="VB.NET" Value="Public Function ToJson () As String" />
<MemberSignature Language="F#" Value="member this.ToJson : unit -> string" Usage="pronunciationAssessmentConfig.ToJson " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets JSON-formatted string of pronunciation assessment parameters.
</summary>
<returns>JSON string of pronunciation assessment parameters.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>