cognitive_services_speech_sdk_rs/common/property_id.rs
1/// PropertyID defines speech property ids.
2pub enum PropertyId {
3 /// SpeechServiceConnectionKey is the Cognitive Services Speech Service subscription key. If you are using an
4 /// intent recognizer, you need to specify the LUIS endpoint key for your particular LUIS app. Under normal
5 /// circumstances, you shouldn't have to use this property directly.
6 /// Instead, use NewSpeechConfigFromSubscription.
7 SpeechServiceConnectionKey = 1000,
8
9 /// SpeechServiceConnectionEndpoint is the Cognitive Services Speech Service endpoint (url).
10 /// Under normal circumstances, you shouldn't have to use this property directly.
11 /// Instead, use NewSpeechConfigFromEndpoint.
12 /// NOTE: This endpoint is not the same as the endpoint used to obtain an access token.
13 SpeechServiceConnectionEndpoint = 1001,
14
15 /// SpeechServiceConnectionRegion is the Cognitive Services Speech Service region. Under normal circumstances,
16 /// you shouldn't have to use this property directly.
17 /// Instead, use NewSpeechConfigFromSubscription, NewSpeechConfigFromEndpoint, NewSpeechConfigFromHost,
18 /// NewSpeechConfigFromAuthorizationToken.
19 SpeechServiceConnectionRegion = 1002,
20
21 /// SpeechServiceAuthorizationToken is the Cognitive Services Speech Service authorization token (aka access token).
22 /// Under normal circumstances, you shouldn't have to use this property directly.
23 /// Instead, use NewSpeechConfigFromAuthorizationToken,
24 /// Recognizer.SetAuthorizationToken
25 SpeechServiceAuthorizationToken = 1003,
26
27 //// SpeechServiceAuthorizationType is the Cognitive Services Speech Service authorization type. Currently unused.
28 SpeechServiceAuthorizationType = 1004,
29
30 /// SpeechServiceConnectionEndpointID is the Cognitive Services Custom Speech Service endpoint id. Under normal
31 /// circumstances, you shouldn't have to use this property directly.
32 /// Instead use SpeechConfig.SetEndpointId.
33 /// NOTE: The endpoint id is available in the Custom Speech Portal, listed under Endpoint Details.
34 SpeechServiceConnectionEndpointId = 1005,
35
36 /// SpeechServiceConnectionHost is the Cognitive Services Speech Service host (url). Under normal circumstances,
37 /// you shouldn't have to use this property directly.
38 /// Instead, use NewSpeechConfigFromHost.
39 SpeechServiceConnectionHost = 1006,
40
41 /// SpeechServiceConnectionProxyHostName is the host name of the proxy server used to connect to the Cognitive Services
42 /// Speech Service. Under normal circumstances, you shouldn't have to use this property directly.
43 /// Instead, use SpeechConfig.SetProxy.
44 SpeechServiceConnectionProxyHostName = 1100,
45
46 /// SpeechServiceConnectionProxyPort is the port of the proxy server used to connect to the Cognitive Services Speech
47 /// Service. Under normal circumstances, you shouldn't have to use this property directly.
48 /// Instead, use SpeechConfig.SetProxy.
49 SpeechServiceConnectionProxyPort = 1101,
50
51 /// SpeechServiceConnectionProxyUserName is the user name of the proxy server used to connect to the Cognitive Services
52 /// Speech Service. Under normal circumstances, you shouldn't have to use this property directly.
53 /// Instead, use SpeechConfig.SetProxy.
54 SpeechServiceConnectionProxyUserName = 1102,
55
56 /// SpeechServiceConnectionProxyPassword is the password of the proxy server used to connect to the Cognitive Services
57 /// Speech Service. Under normal circumstances, you shouldn't have to use this property directly.
58 /// Instead, use SpeechConfig.SetProxy.
59 SpeechServiceConnectionProxyPassword = 1103,
60
61 /// SpeechServiceConnectionURL is the URL string built from speech configuration. This property is intended to be read-only.
62 /// The SDK is using it internally.
63 SpeechServiceConnectionURL = 1104,
64
65 /// SpeechServiceConnectionTranslationToLanguages is the list of comma separated languages used as target translation
66 /// languages. Under normal circumstances, you shouldn't have to use this property directly.
67 /// Instead use SpeechTranslationConfig.AddTargetLanguage and SpeechTranslationConfig.GetTargetLanguages.
68 SpeechServiceConnectionTranslationToLanguages = 2000,
69
70 /// SpeechServiceConnectionTranslationVoice is the name of the Cognitive Service Text to Speech Service voice. Under normal
71 /// circumstances, you shouldn't have to use this property directly.
72 /// Instead use SpeechTranslationConfig.SetVoiceName.
73 /// NOTE: Valid voice names can be found at https:///aka.ms/csspeech/voicenames.
74 SpeechServiceConnectionTranslationVoice = 2001,
75
76 /// SpeechServiceConnectionTranslationFeatures is the translation features. For internal use.
77 SpeechServiceConnectionTranslationFeatures = 2002,
78
79 /// SpeechServiceConnectionIntentRegion is the Language Understanding Service region. Under normal circumstances, you
80 /// shouldn't have to use this property directly.
81 /// Instead use LanguageUnderstandingModel.
82 SpeechServiceConnectionIntentRegion = 2003,
83
84 /// SpeechServiceConnectionRecoMode is the Cognitive Services Speech Service recognition mode. Can be "INTERACTIVE",
85 /// "CONVERSATION" or "DICTATION".
86 /// This property is intended to be read-only. The SDK is using it internally.
87 SpeechServiceConnectionRecoMode = 3000,
88
89 /// SpeechServiceConnectionRecoLanguage is the spoken language to be recognized (in BCP-47 format). Under normal
90 /// circumstances, you shouldn't have to use this property directly.
91 /// Instead, use SpeechConfig.SetSpeechRecognitionLanguage.
92 SpeechServiceConnectionRecoLanguage = 3001,
93
94 /// SpeechSessionID is the session id. This id is a universally unique identifier (aka UUID) representing a specific
95 /// binding of an audio input stream and the underlying speech recognition instance to which it is bound. Under normal
96 /// circumstances, you shouldn't have to use this property directly.
97 //// Instead use SessionEventArgs.SessionId.
98 SpeechSessionId = 3002,
99
100 /// SpeechServiceConnectionUserDefinedQueryParameters are the query parameters provided by users. They will be passed
101 /// to the service as URL query parameters.
102 SpeechServiceConnectionUserDefinedQueryParameters = 3003,
103
104 /// The name of the model to be used for speech recognition.
105 /// Under normal circumstances, you shouldn't use this property directly.
106 /// Currently this is only valid when EmbeddedSpeechConfig is used.
107 /// Added in version 1.19.0
108 SpeechServiceConnectionRecoModelName = 3005,
109
110 /// The decryption key of the model to be used for speech recognition.
111 /// Under normal circumstances, you shouldn't use this property directly.
112 /// Currently this is only valid when EmbeddedSpeechConfig is used.
113 /// Added in version 1.19.0
114 SpeechServiceConnectionRecoModelKey = 3006,
115
116 /// The path to the ini file of the model to be used for speech recognition.
117 /// Under normal circumstances, you shouldn't use this property directly.
118 /// Currently this is only valid when EmbeddedSpeechConfig is used.
119 /// Added in version 1.19.0
120 SpeechServiceConnectionRecoModelIniFile = 3007,
121
122 //// SpeechServiceConnectionSynthLanguage is the spoken language to be synthesized (e.g. en-US)
123 SpeechServiceConnectionSynthLanguage = 3100,
124
125 /// SpeechServiceConnectionSynthVoice is the name of the TTS voice to be used for speech synthesis
126 SpeechServiceConnectionSynthVoice = 3101,
127
128 /// SpeechServiceConnectionSynthOutputFormat is the string to specify TTS output audio format.
129 SpeechServiceConnectionSynthOutputFormat = 3102,
130
131 /// SpeechServiceConnectionSynthEnableCompressedAudioTransmission indicates if use compressed audio format
132 /// for speech synthesis audio transmission.
133 /// This property only affects when SpeechServiceConnectionSynthOutputFormat is set to a pcm format.
134 /// If this property is not set and GStreamer is available, SDK will use compressed format for synthesized audio transmission,
135 /// and decode it. You can set this property to "false" to use raw pcm format for transmission on wire.
136 SpeechServiceConnectionSynthEnableCompressedAudioTransmission = 3103,
137
138 /// The string to specify TTS backend; valid options are online and offline.
139 /// Under normal circumstances, you shouldn't have to use this property directly.
140 /// Instead, use <see cref="EmbeddedSpeechConfig::FromPath"/> or <see cref="EmbeddedSpeechConfig::FromPaths"/>
141 /// to set the synthesis backend to offline.
142 /// Added in version 1.19.0
143 SpeechServiceConnectionSynthBackend = 3110,
144
145 /// The data file path(s) for offline synthesis engine; only valid when synthesis backend is offline.
146 /// Under normal circumstances, you shouldn't have to use this property directly.
147 /// Instead, use <see cref="EmbeddedSpeechConfig::FromPath"/> or <see cref="EmbeddedSpeechConfig::FromPaths"/>.
148 /// Added in version 1.19.0
149 SpeechServiceConnectionSynthOfflineDataPath = 3112,
150
151 /// The name of the offline TTS voice to be used for speech synthesis
152 /// Under normal circumstances, you shouldn't use this property directly.
153 /// Added in version 1.19.0
154 SpeechServiceConnectionSynthOfflineVoice = 3113,
155
156 /// The decryption key of the voice to be used for speech synthesis.
157 /// Under normal circumstances, you shouldn't use this property directly.
158 /// Added in version 1.19.0
159 SpeechServiceConnectionSynthModelKey = 3114,
160
161 /// The Cognitive Services Speech Service voices list api endpoint (url). Under normal circumstances,
162 /// you don't need to specify this property, SDK will construct it based on the region/host/endpoint of <see cref="SpeechConfig"/>.
163 /// Added in version 1.16.0
164 SpeechServiceConnectionVoicesListEndpoint = 3130,
165
166 /// SpeechServiceConnectionInitialSilenceTimeoutMs is the initial silence timeout value (in milliseconds) used by the
167 /// service.
168 SpeechServiceConnectionInitialSilenceTimeoutMs = 3200,
169
170 /// SpeechServiceConnectionEndSilenceTimeoutMs is the end silence timeout value (in milliseconds) used by the service.
171 SpeechServiceConnectionEndSilenceTimeoutMs = 3201,
172
173 /// SpeechServiceConnectionEnableAudioLogging is a boolean value specifying whether audio logging is enabled in the service
174 /// or not.
175 SpeechServiceConnectionEnableAudioLogging = 3202,
176
177 /// The speech service connection language identifier mode.
178 /// Can be "AtStart" (the default), or "Continuous". See [Language
179 /// Identification](https://aka.ms/speech/lid?pivots=programming-language-cpp) document.
180 /// Added in 1.25.0
181 SpeechServiceConnectionLanguageIdMode = 3205,
182
183 /// The auto detect source languages
184 /// Added in version 1.8.0
185 SpeechServiceConnectionAutoDetectSourceLanguages = 3300,
186
187 /// The auto detect source language result
188 /// Added in version 1.8.0
189 SpeechServiceConnectionAutoDetectSourceLanguageResult = 3301,
190
191 /// SpeechServiceResponseRequestDetailedResultTrueFalse the requested Cognitive Services Speech Service response output
192 /// format (simple or detailed). Under normal circumstances, you shouldn't have to use this property directly.
193 /// Instead use SpeechConfig.SetOutputFormat.
194 SpeechServiceResponseRequestDetailedResultTrueFalse = 4000,
195
196 /// SpeechServiceResponseRequestProfanityFilterTrueFalse is the requested Cognitive Services Speech Service response
197 /// output profanity level. Currently unused.
198 SpeechServiceResponseRequestProfanityFilterTrueFalse = 4001,
199
200 /// SpeechServiceResponseProfanityOption is the requested Cognitive Services Speech Service response output profanity
201 /// setting.
202 /// Allowed values are "masked", "removed", and "raw".
203 SpeechServiceResponseProfanityOption = 4002,
204
205 /// SpeechServiceResponsePostProcessingOption a string value specifying which post processing option should be used
206 /// by the service.
207 /// Allowed values are "TrueText".
208 SpeechServiceResponsePostProcessingOption = 4003,
209
210 /// SpeechServiceResponseRequestWordLevelTimestamps is a boolean value specifying whether to include word-level
211 /// timestamps in the response result.
212 SpeechServiceResponseRequestWordLevelTimestamps = 4004,
213
214 /// SpeechServiceResponseStablePartialResultThreshold is the number of times a word has to be in partial results
215 /// to be returned.
216 SpeechServiceResponseStablePartialResultThreshold = 4005,
217
218 /// SpeechServiceResponseOutputFormatOption is a string value specifying the output format option in the response
219 /// result. Internal use only.
220 SpeechServiceResponseOutputFormatOption = 4006,
221
222 /// A boolean value specifying whether to include SNR (signal to noise ratio) in the response result.
223 /// Added in version 1.18.0
224 SpeechServiceResponseRequestSnr = 4007,
225
226 /// SpeechServiceResponseTranslationRequestStablePartialResult is a boolean value to request for stabilizing translation
227 /// partial results by omitting words in the end.
228 SpeechServiceResponseTranslationRequestStablePartialResult = 4100,
229
230 /// A boolean value specifying whether to request WordBoundary events.
231 /// Added in version 1.21.0.
232 SpeechServiceResponseRequestWordBoundary = 4200,
233
234 /// A boolean value specifying whether to request punctuation boundary in WordBoundary Events. Default is true.
235 /// Added in version 1.21.0.
236 SpeechServiceResponseRequestPunctuationBoundary = 4201,
237
238 /// A boolean value specifying whether to request sentence boundary in WordBoundary Events. Default is false.
239 /// Added in version 1.21.0.
240 SpeechServiceResponseRequestSentenceBoundary = 4202,
241
242 /// A boolean value specifying whether the SDK should synchronize synthesis metadata events,
243 /// (e.g. word boundary, viseme, etc.) to the audio playback. This only takes effect when the audio is played through the SDK.
244 /// Default is true.
245 /// If set to false, the SDK will fire the events as they come from the service, which may be out of sync with the audio playback.
246 /// Added in version 1.31.0.
247 SpeechServiceResponseSynthesisEventsSyncToAudio = 4210,
248
249 /// SpeechServiceResponseJSONResult is the Cognitive Services Speech Service response output (in JSON format). This
250 /// property is available on recognition result objects only.
251 SpeechServiceResponseJsonResult = 5000,
252
253 /// SpeechServiceResponseJSONErrorDetails is the Cognitive Services Speech Service error details (in JSON format).
254 /// Under normal circumstances, you shouldn't have to use this property directly.
255 /// Instead, use CancellationDetails.ErrorDetails.
256 SpeechServiceResponseJsonErrorDetails = 5001,
257
258 /// SpeechServiceResponseRecognitionLatencyMs is the recognition latency in milliseconds. Read-only, available on final
259 /// speech/translation/intent results. This measures the latency between when an audio input is received by the SDK, and
260 /// the moment the final result is received from the service. The SDK computes the time difference between the last audio
261 /// fragment from the audio input that is contributing to the final result, and the time the final result is received from
262 /// the speech service.
263 SpeechServiceResponseRecognitionLatencyMs = 5002,
264
265 /// The recognition backend. Read-only, available on speech recognition results.
266 /// This indicates whether cloud (online) or embedded (offline) recognition was used to produce the result.
267 SpeechServiceResponseRecognitionBackend = 5003,
268
269 /// SpeechServiceResponseSynthesisFirstByteLatencyMs is the speech synthesis first byte latency in milliseconds.
270 /// Read-only, available on final speech synthesis results.
271 /// This measures the latency between when the synthesis is started to be processed, and the moment the first byte audio is available.
272 /// Added in version 1.17.0.
273 SpeechServiceResponseSynthesisFirstByteLatencyMs = 5010,
274
275 /// SpeechServiceResponseSynthesisFinishLatencyMs is the speech synthesis all bytes latency in milliseconds.
276 /// Read-only, available on final speech synthesis results.
277 /// This measures the latency between when the synthesis is started to be processed, and the moment the whole audio is synthesized.
278 /// Added in version 1.17.0.
279 SpeechServiceResponseSynthesisFinishLatencyMs = 5011,
280
281 /// SpeechServiceResponseSynthesisUnderrunTimeMs is the underrun time for speech synthesis in milliseconds.
282 /// Read-only, available on results in SynthesisCompleted events.
283 /// This measures the total underrun time from AudioConfigPlaybackBufferLengthInMs is filled to synthesis completed.
284 /// Added in version 1.17.0.
285 SpeechServiceResponseSynthesisUnderrunTimeMs = 5012,
286
287 /// The speech synthesis connection latency in milliseconds. Read-only, available on final speech synthesis results.
288 /// This measures the latency between when the synthesis is started to be processed, and the moment the HTTP/WebSocket connection is established.
289 /// Added in version 1.26.0.
290 SpeechServiceResponseSynthesisConnectionLatencyMs = 5013,
291
292 /// The speech synthesis network latency in milliseconds. Read-only, available on final speech synthesis results.
293 /// This measures the network round trip time.
294 /// Added in version 1.26.0.
295 SpeechServiceResponseSynthesisNetworkLatencyMs = 5014,
296
297 /// The speech synthesis service latency in milliseconds. Read-only, available on final speech synthesis results.
298 /// This measures the service processing time to synthesize the first byte of audio.
299 /// Added in version 1.26.0.
300 SpeechServiceResponseSynthesisServiceLatencyMs = 5015,
301
302 /// SpeechServiceResponseSynthesisBackend indicates which backend the synthesis is finished by.
303 /// Read-only, available on speech synthesis results, except for the result in SynthesisStarted event
304 /// Added in version 1.17.0.
305 SpeechServiceResponseSynthesisBackend = 5020,
306
307 /// CancellationDetailsReason is the cancellation reason. Currently unused.
308 CancellationDetailsReason = 6000,
309
310 /// CancellationDetailsReasonText the cancellation text. Currently unused.
311 CancellationDetailsReasonText = 6001,
312
313 /// CancellationDetailsReasonDetailedText is the cancellation detailed text. Currently unused.
314 CancellationDetailsReasonDetailedText = 6002,
315
316 /// LanguageUnderstandingServiceResponseJSONResult is the Language Understanding Service response output (in JSON format).
317 /// Available via IntentRecognitionResult.Properties.
318 LanguageUnderstandingServiceResponseJsonResult = 7000,
319
320 /// AudioConfigDeviceNameForCapture is the device name for audio capture. Under normal circumstances, you shouldn't have
321 /// to use this property directly.
322 /// Instead, use AudioConfig.FromMicrophoneInput.
323 AudioConfigDeviceNameForCapture = 8000,
324
325 /// AudioConfigNumberOfChannelsForCapture is the number of channels for audio capture. Internal use only.
326 AudioConfigNumberOfChannelsForCapture = 8001,
327
328 /// AudioConfigSampleRateForCapture is the sample rate (in Hz) for audio capture. Internal use only.
329 AudioConfigSampleRateForCapture = 8002,
330
331 /// AudioConfigBitsPerSampleForCapture is the number of bits of each sample for audio capture. Internal use only.
332 AudioConfigBitsPerSampleForCapture = 8003,
333
334 /// AudioConfigAudioSource is the audio source. Allowed values are "Microphones", "File", and "Stream".
335 AudioConfigAudioSource = 8004,
336
337 // AudioConfigDeviceNameForRender indicates the device name for audio render. Under normal circumstances,
338 /// you shouldn't have to use this property directly. Instead, use NewAudioConfigFromDefaultSpeakerOutput.
339 /// Added in version 1.17.0
340 AudioConfigDeviceNameForRender = 8005,
341
342 /// AudioConfigPlaybackBufferLengthInMs indicates the playback buffer length in milliseconds, default is 50 milliseconds.
343 AudioConfigPlaybackBufferLengthInMs = 8006,
344
345 /// Audio processing options in JSON format.
346 AudioConfigAudioProcessingOptions = 8007,
347
348 /// SpeechLogFilename is the file name to write logs.
349 SpeechLogFilename = 9001,
350
351 /// A duration of detected silence, measured in milliseconds, after which speech-to-text will determine a spoken
352 /// phrase has ended and generate a final Recognized result. Configuring this timeout may be helpful in situations
353 /// where spoken input is significantly faster or slower than usual and default segmentation behavior consistently
354 /// yields results that are too long or too short. Segmentation timeout values that are inappropriately high or low
355 /// can negatively affect speech-to-text accuracy; this property should be carefully configured and the resulting
356 /// behavior should be thoroughly validated as intended.
357 ///
358 /// For more information about timeout configuration that includes discussion of default behaviors, please visit
359 /// https://aka.ms/csspeech/timeouts.
360 SpeechSegmentationSilenceTimeoutMs = 9002,
361
362 /// ConversationApplicationID is the identifier used to connect to the backend service.
363 ConversationApplicationID = 10000,
364
365 /// ConversationDialogType is the type of dialog backend to connect to.
366 ConversationDialogType = 10001,
367
368 /// ConversationInitialSilenceTimeout is the silence timeout for listening.
369 ConversationInitialSilenceTimeout = 10002,
370
371 /// ConversationFromID is the FromId to be used on speech recognition activities.
372 ConversationFromID = 10003,
373
374 /// ConversationConversationID is the ConversationId for the session.
375 ConversationConversationID = 10004,
376
377 /// ConversationCustomVoiceDeploymentIDs is a comma separated list of custom voice deployment ids.
378 ConversationCustomVoiceDeploymentIDs = 10005,
379
380 /// ConversationSpeechActivityTemplate is use to stamp properties in the template on the activity generated by the service for speech.
381 ConversationSpeechActivityTemplate = 10006,
382
383 /// Your participant identifier in the current conversation.
384 /// Added in version 1.13.0
385 ConversationParticipantId = 10007,
386
387 // If specified as true, request that the service send MessageStatus payloads via the ActivityReceived event
388 // handler. These messages communicate the outcome of ITurnContext resolution from the dialog system.
389 // Added in version 1.14.0.
390 ConversationRequestBotStatusMessages = 10008,
391
392 // Additional identifying information, such as a Direct Line token, used to authenticate with the backend service.
393 // Added in version 1.16.0.
394 ConversationConnectionId = 10009,
395
396 /// DataBufferTimeStamp is the time stamp associated to data buffer written by client when using Pull/Push
397 /// audio input streams.
398 /// The time stamp is a 64-bit value with a resolution of 90 kHz. It is the same as the presentation timestamp
399 /// in an MPEG transport stream. See https:///en.wikipedia.org/wiki/Presentation_timestamp
400 DataBufferTimeStamp = 11001,
401
402 /// DataBufferUserID is the user id associated to data buffer written by client when using Pull/Push audio
403 /// input streams.
404 DataBufferUserID = 11002,
405
406 /// The reference text of the audio for pronunciation evaluation.
407 /// For this and the following pronunciation assessment parameters, see the table
408 /// [Pronunciation assessment parameters](/azure/cognitive-services/speech-service/rest-speech-to-text-short#pronunciation-assessment-parameters).
409 /// Under normal circumstances, you shouldn't have to use this property directly.
410 /// Instead, use <see cref="PronunciationAssessmentConfig::Create"/> or <see cref="PronunciationAssessmentConfig::SetReferenceText"/>.
411 /// Added in version 1.14.0
412 PronunciationAssessmentReferenceText = 12001,
413
414 /// The point system for pronunciation score calibration (FivePoint or HundredMark).
415 /// Under normal circumstances, you shouldn't have to use this property directly.
416 /// Instead, use <see cref="PronunciationAssessmentConfig::Create"/>.
417 /// Added in version 1.14.0
418 PronunciationAssessmentGradingSystem = 12002,
419
420 /// The pronunciation evaluation granularity (Phoneme, Word, or FullText).
421 /// Under normal circumstances, you shouldn't have to use this property directly.
422 /// Instead, use <see cref="PronunciationAssessmentConfig::Create"/>.
423 /// Added in version 1.14.0
424 PronunciationAssessmentGranularity = 12003,
425
426 /// Defines if enable miscue calculation.
427 /// With this enabled, the pronounced words will be compared to the reference text,
428 /// and will be marked with omission/insertion based on the comparison. The default setting is False.
429 /// Under normal circumstances, you shouldn't have to use this property directly.
430 /// Instead, use <see cref="PronunciationAssessmentConfig::Create"/>.
431 /// Added in version 1.14.0
432 PronunciationAssessmentEnableMiscue = 12005,
433
434 /// The pronunciation evaluation phoneme alphabet. The valid values are "SAPI" (default) and "IPA"
435 /// Under normal circumstances, you shouldn't have to use this property directly.
436 /// Instead, use <see cref="PronunciationAssessmentConfig::SetPhonemeAlphabet"/>.
437 /// Added in version 1.20.0
438 PronunciationAssessmentPhonemeAlphabet = 12006,
439
440 /// The pronunciation evaluation nbest phoneme count.
441 /// Under normal circumstances, you shouldn't have to use this property directly.
442 /// Instead, use <see cref="PronunciationAssessmentConfig::SetNBestPhonemeCount"/>.
443 /// Added in version 1.20.0
444 PronunciationAssessmentNBestPhonemeCount = 12007,
445
446 /// Whether to enable prosody assessment.
447 /// Under normal circumstances, you shouldn't have to use this property directly.
448 /// Instead, use <see cref="PronunciationAssessmentConfig::EnableProsodyAssessment"/>.
449 /// Added in version 1.33.0
450 PronunciationAssessmentEnableProsodyAssessment = 12008,
451
452 /// The json string of pronunciation assessment parameters
453 /// Under normal circumstances, you shouldn't have to use this property directly.
454 /// Instead, use <see cref="PronunciationAssessmentConfig::Create"/>.
455 /// Added in version 1.14.0
456 PronunciationAssessmentJson = 12009,
457
458 /// Pronunciation assessment parameters.
459 /// This property is intended to be read-only. The SDK is using it internally.
460 /// Added in version 1.14.0
461 PronunciationAssessmentParams = 12010,
462
463 /// The content topic of the pronunciation assessment.
464 /// Under normal circumstances, you shouldn't have to use this property directly.
465 /// Instead, use <see cref="PronunciationAssessmentConfig::EnableContentAssessmentWithTopic"/>.
466 /// Added in version 1.33.0
467 PronunciationAssessmentContentTopic = 12020,
468
469 /// Speaker Recognition backend API version.
470 /// This property is added to allow testing and use of previous versions of Speaker Recognition APIs, where applicable.
471 /// Added in version 1.18.0
472 SpeakerRecognitionApiVersion = 13001,
473
474 /// The name of a model to be used for speech translation.
475 /// Do not use this property directly.
476 /// Currently this is only valid when EmbeddedSpeechConfig is used.
477 SpeechTranslationModelName = 13100,
478
479 /// The decryption key of a model to be used for speech translation.
480 /// Do not use this property directly.
481 /// Currently this is only valid when EmbeddedSpeechConfig is used.
482 SpeechTranslationModelKey = 13101,
483
484 /// The name of a model to be used for keyword recognition.
485 /// Do not use this property directly.
486 /// Currently this is only valid when EmbeddedSpeechConfig is used.
487 KeywordRecognitionModelName = 13200,
488
489 /// The decryption key of a model to be used for keyword recognition.
490 /// Do not use this property directly.
491 /// Currently this is only valid when EmbeddedSpeechConfig is used.
492 KeywordRecognitionModelKey = 13201,
493
494 /// Enable the collection of embedded speech performance metrics which can
495 /// be used to evaluate the capability of a device to use embedded speech.
496 /// The collected data is included in results from specific scenarios like
497 /// speech recognition.
498 /// The default setting is "false". Note that metrics may not be available
499 /// from all embedded speech scenarios.
500 EmbeddedSpeechEnablePerformanceMetrics = 13300,
501}
502
503impl PropertyId {
504 pub fn to_i32(&self) -> i32 {
505 match self {
506 PropertyId::SpeechServiceConnectionKey => 1000,
507 PropertyId::SpeechServiceConnectionEndpoint => 1001,
508 PropertyId::SpeechServiceConnectionRegion => 1002,
509 PropertyId::SpeechServiceAuthorizationToken => 1003,
510 PropertyId::SpeechServiceAuthorizationType => 1004,
511 PropertyId::SpeechServiceConnectionEndpointId => 1005,
512 PropertyId::SpeechServiceConnectionHost => 1006,
513
514 PropertyId::SpeechServiceConnectionProxyHostName => 1100,
515 PropertyId::SpeechServiceConnectionProxyPort => 1101,
516 PropertyId::SpeechServiceConnectionProxyUserName => 1102,
517 PropertyId::SpeechServiceConnectionProxyPassword => 1103,
518 PropertyId::SpeechServiceConnectionURL => 1104,
519
520 PropertyId::SpeechServiceConnectionTranslationToLanguages => 2000,
521 PropertyId::SpeechServiceConnectionTranslationVoice => 2001,
522 PropertyId::SpeechServiceConnectionTranslationFeatures => 2002,
523 PropertyId::SpeechServiceConnectionIntentRegion => 2003,
524
525 PropertyId::SpeechServiceConnectionRecoMode => 3000,
526 PropertyId::SpeechServiceConnectionRecoLanguage => 3001,
527 PropertyId::SpeechSessionId => 3002,
528 PropertyId::SpeechServiceConnectionUserDefinedQueryParameters => 3003,
529 PropertyId::SpeechServiceConnectionRecoModelName => 3005,
530 PropertyId::SpeechServiceConnectionRecoModelKey => 3006,
531 PropertyId::SpeechServiceConnectionRecoModelIniFile => 3007,
532
533 PropertyId::SpeechServiceConnectionSynthLanguage => 3100,
534 PropertyId::SpeechServiceConnectionSynthVoice => 3101,
535 PropertyId::SpeechServiceConnectionSynthOutputFormat => 3102,
536 PropertyId::SpeechServiceConnectionSynthEnableCompressedAudioTransmission => 3103,
537 PropertyId::SpeechServiceConnectionSynthBackend => 3110,
538 PropertyId::SpeechServiceConnectionSynthOfflineDataPath => 3112,
539 PropertyId::SpeechServiceConnectionSynthOfflineVoice => 3113,
540 PropertyId::SpeechServiceConnectionSynthModelKey => 3114,
541 PropertyId::SpeechServiceConnectionVoicesListEndpoint => 3130,
542
543 PropertyId::SpeechServiceConnectionInitialSilenceTimeoutMs => 3200,
544 PropertyId::SpeechServiceConnectionEndSilenceTimeoutMs => 3201,
545 PropertyId::SpeechServiceConnectionEnableAudioLogging => 3202,
546 PropertyId::SpeechServiceConnectionLanguageIdMode => 3205,
547
548 PropertyId::SpeechServiceConnectionAutoDetectSourceLanguages => 3300,
549 PropertyId::SpeechServiceConnectionAutoDetectSourceLanguageResult => 3301,
550
551 PropertyId::SpeechServiceResponseRequestDetailedResultTrueFalse => 4000,
552 PropertyId::SpeechServiceResponseRequestProfanityFilterTrueFalse => 4001,
553 PropertyId::SpeechServiceResponseProfanityOption => 4002,
554 PropertyId::SpeechServiceResponsePostProcessingOption => 4003,
555 PropertyId::SpeechServiceResponseRequestWordLevelTimestamps => 4004,
556 PropertyId::SpeechServiceResponseStablePartialResultThreshold => 4005,
557 PropertyId::SpeechServiceResponseOutputFormatOption => 4006,
558 PropertyId::SpeechServiceResponseRequestSnr => 4007,
559
560 PropertyId::SpeechServiceResponseTranslationRequestStablePartialResult => 4100,
561
562 PropertyId::SpeechServiceResponseRequestWordBoundary => 4200,
563 PropertyId::SpeechServiceResponseRequestPunctuationBoundary => 4201,
564 PropertyId::SpeechServiceResponseRequestSentenceBoundary => 4202,
565 PropertyId::SpeechServiceResponseSynthesisEventsSyncToAudio => 4210,
566
567 PropertyId::SpeechServiceResponseJsonResult => 5000,
568 PropertyId::SpeechServiceResponseJsonErrorDetails => 5001,
569 PropertyId::SpeechServiceResponseRecognitionLatencyMs => 5002,
570 PropertyId::SpeechServiceResponseRecognitionBackend => 5003,
571 PropertyId::SpeechServiceResponseSynthesisFirstByteLatencyMs => 5010,
572 PropertyId::SpeechServiceResponseSynthesisFinishLatencyMs => 5011,
573 PropertyId::SpeechServiceResponseSynthesisUnderrunTimeMs => 5012,
574 PropertyId::SpeechServiceResponseSynthesisConnectionLatencyMs => 5013,
575 PropertyId::SpeechServiceResponseSynthesisNetworkLatencyMs => 5014,
576 PropertyId::SpeechServiceResponseSynthesisServiceLatencyMs => 5015,
577 PropertyId::SpeechServiceResponseSynthesisBackend => 5020,
578
579 PropertyId::CancellationDetailsReason => 6000,
580 PropertyId::CancellationDetailsReasonText => 6001,
581 PropertyId::CancellationDetailsReasonDetailedText => 6002,
582
583 PropertyId::LanguageUnderstandingServiceResponseJsonResult => 7000,
584
585 PropertyId::AudioConfigDeviceNameForCapture => 8000,
586 PropertyId::AudioConfigNumberOfChannelsForCapture => 8001,
587 PropertyId::AudioConfigSampleRateForCapture => 8002,
588 PropertyId::AudioConfigBitsPerSampleForCapture => 8003,
589 PropertyId::AudioConfigAudioSource => 8004,
590 PropertyId::AudioConfigDeviceNameForRender => 8005,
591 PropertyId::AudioConfigPlaybackBufferLengthInMs => 8006,
592 PropertyId::AudioConfigAudioProcessingOptions => 8007,
593
594 PropertyId::SpeechLogFilename => 9001,
595 PropertyId::SpeechSegmentationSilenceTimeoutMs => 9002,
596
597 PropertyId::ConversationApplicationID => 10000,
598 PropertyId::ConversationDialogType => 10001,
599 PropertyId::ConversationInitialSilenceTimeout => 10002,
600 PropertyId::ConversationFromID => 10003,
601 PropertyId::ConversationConversationID => 10004,
602 PropertyId::ConversationCustomVoiceDeploymentIDs => 10005,
603 PropertyId::ConversationSpeechActivityTemplate => 10006,
604 PropertyId::ConversationParticipantId => 10007,
605 PropertyId::ConversationRequestBotStatusMessages => 10008,
606 PropertyId::ConversationConnectionId => 10009,
607
608 PropertyId::DataBufferTimeStamp => 11001,
609 PropertyId::DataBufferUserID => 11002,
610
611 PropertyId::PronunciationAssessmentReferenceText => 12001,
612 PropertyId::PronunciationAssessmentGradingSystem => 12002,
613 PropertyId::PronunciationAssessmentGranularity => 12003,
614 PropertyId::PronunciationAssessmentEnableMiscue => 12005,
615 PropertyId::PronunciationAssessmentPhonemeAlphabet => 12006,
616 PropertyId::PronunciationAssessmentNBestPhonemeCount => 12007,
617 PropertyId::PronunciationAssessmentEnableProsodyAssessment => 12008,
618 PropertyId::PronunciationAssessmentJson => 12009,
619 PropertyId::PronunciationAssessmentParams => 12010,
620 PropertyId::PronunciationAssessmentContentTopic => 12020,
621
622 PropertyId::SpeakerRecognitionApiVersion => 13001,
623
624 PropertyId::SpeechTranslationModelName => 13100,
625 PropertyId::SpeechTranslationModelKey => 13101,
626
627 PropertyId::KeywordRecognitionModelName => 13200,
628 PropertyId::KeywordRecognitionModelKey => 13201,
629
630 PropertyId::EmbeddedSpeechEnablePerformanceMetrics => 13300,
631 }
632 }
633}