Table of Contents

Class SpeechToTextRequest

Namespace
Glitch9.AIDevKit.Microsoft
public class SpeechToTextRequest : IMultipartFormRequest
Inheritance
object
SpeechToTextRequest

Properties

Dimension

Optional. Defines the output criteria. Accepted values are:

Basic — shows the accuracy score only. Comprehensive — shows scores on more dimensions (for example, fluency score and completeness score on the full-text level, and error type on the word level).

Default: Basic.

public string Dimension { get; set; }

Property Value

string

EnableMiscue

Optional. Enables miscue calculation. With this enabled, the pronounced words are compared to the reference text and marked with omission or insertion based on the comparison. Accepted values: False, True. Default: False.

public bool? EnableMiscue { get; set; }

Property Value

bool?

EnableProsodyAssessment

Optional. Enables prosody assessment for pronunciation evaluation. Assesses stress, intonation, speaking speed, and rhythm, providing insights into naturalness and expressiveness. If set to True, the ProsodyScore result value is returned.

public bool? EnableProsodyAssessment { get; set; }

Property Value

bool?

File 

public byte[] File { get; set; }

Property Value

byte[]

Format

Optional.
Specifies the result format. Accepted values are simple and detailed.

Simple results include:

  • RecognitionStatus
  • DisplayText
  • Offset
  • Duration

    Detailed responses include four different representations of display text.
    The default setting is simple.
public string Format { get; set; }

Property Value

string

GradingSystem

Optional. The point system for score calibration. The FivePoint system gives a 0-5 floating point score, and HundredMark gives a 0-100 floating point score. Default: FivePoint.

public string GradingSystem { get; set; }

Property Value

string

Granularity

Optional. The evaluation granularity. Accepted values are:

Phoneme — shows the score on the full-text, word, and phoneme levels. Word — shows the score on the full-text and word levels. FullText — shows the score on the full-text level only.

Default: Phoneme.

public string Granularity { get; set; }

Property Value

string

Language

Required.
Identifies the spoken language that's being recognized. See Supported languages.

public string Language { get; set; }

Property Value

string

Profanity

Optional.
Specifies how to handle profanity in recognition results. Accepted values are:

  • masked, which replaces profanity with asterisks.
  • removed, which removes all profanity from the result.
  • raw, which includes profanity in the result.


    The default setting is masked.
public string Profanity { get; set; }

Property Value

string

ReferenceText

Required. The text that the pronunciation is evaluated against.

public string ReferenceText { get; set; }

Property Value

string

ScenarioId

Optional. A GUID that indicates a customized point system.

public string ScenarioId { get; set; }

Property Value

string